1 # -*- coding: utf-8 -*-
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from uuid
import uuid4
18 from hashlib
import sha256
19 from http
import HTTPStatus
21 from osm_nbi
.validation
import (
26 vim_account_new_schema
,
27 vim_account_edit_schema
,
30 wim_account_new_schema
,
31 wim_account_edit_schema
,
34 k8scluster_new_schema
,
35 k8scluster_edit_schema
,
45 ) # To check that User/Project Names don't look like UUIDs
46 from osm_nbi
.base_topic
import BaseTopic
, EngineException
47 from osm_nbi
.authconn
import AuthconnNotFoundException
, AuthconnConflictException
48 from osm_common
.dbbase
import deep_update_rfc7396
51 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
54 class UserTopic(BaseTopic
):
57 schema_new
= user_new_schema
58 schema_edit
= user_edit_schema
61 def __init__(self
, db
, fs
, msg
, auth
):
62 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
65 def _get_project_filter(session
):
67 Generates a filter dictionary for querying database users.
68 Current policy is admin can show all, non admin, only its own user.
69 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
72 if session
["admin"]: # allows all
75 return {"username": session
["username"]}
77 def check_conflict_on_new(self
, session
, indata
):
78 # check username not exists
81 {"username": indata
.get("username")},
85 raise EngineException(
86 "username '{}' exists".format(indata
["username"]), HTTPStatus
.CONFLICT
89 if not session
["force"]:
90 for p
in indata
.get("projects") or []:
91 # To allow project addressing by Name as well as ID
92 if not self
.db
.get_one(
94 {BaseTopic
.id_field("projects", p
): p
},
98 raise EngineException(
99 "project '{}' does not exist".format(p
), HTTPStatus
.CONFLICT
102 def check_conflict_on_del(self
, session
, _id
, db_content
):
104 Check if deletion can be done because of dependencies if it is not force. To override
105 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
106 :param _id: internal _id
107 :param db_content: The database content of this item _id
108 :return: None if ok or raises EngineException with the conflict
110 if _id
== session
["username"]:
111 raise EngineException(
112 "You cannot delete your own user", http_code
=HTTPStatus
.CONFLICT
116 def format_on_new(content
, project_id
=None, make_public
=False):
117 BaseTopic
.format_on_new(content
, make_public
=False)
118 # Removed so that the UUID is kept, to allow User Name modification
119 # content["_id"] = content["username"]
121 content
["_admin"]["salt"] = salt
122 if content
.get("password"):
123 content
["password"] = sha256(
124 content
["password"].encode("utf-8") + salt
.encode("utf-8")
126 if content
.get("project_role_mappings"):
128 mapping
["project"] for mapping
in content
["project_role_mappings"]
131 if content
.get("projects"):
132 content
["projects"] += projects
134 content
["projects"] = projects
137 def format_on_edit(final_content
, edit_content
):
138 BaseTopic
.format_on_edit(final_content
, edit_content
)
139 if edit_content
.get("password"):
141 final_content
["_admin"]["salt"] = salt
142 final_content
["password"] = sha256(
143 edit_content
["password"].encode("utf-8") + salt
.encode("utf-8")
147 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
148 if not session
["admin"]:
149 raise EngineException(
150 "needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
152 # Names that look like UUIDs are not allowed
153 name
= (indata
if indata
else kwargs
).get("username")
154 if is_valid_uuid(name
):
155 raise EngineException(
156 "Usernames that look like UUIDs are not allowed",
157 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
,
159 return BaseTopic
.edit(
160 self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
163 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
164 if not session
["admin"]:
165 raise EngineException(
166 "needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
168 # Names that look like UUIDs are not allowed
169 name
= indata
["username"] if indata
else kwargs
["username"]
170 if is_valid_uuid(name
):
171 raise EngineException(
172 "Usernames that look like UUIDs are not allowed",
173 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
,
175 return BaseTopic
.new(
176 self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
180 class ProjectTopic(BaseTopic
):
182 topic_msg
= "projects"
183 schema_new
= project_new_schema
184 schema_edit
= project_edit_schema
187 def __init__(self
, db
, fs
, msg
, auth
):
188 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
191 def _get_project_filter(session
):
193 Generates a filter dictionary for querying database users.
194 Current policy is admin can show all, non admin, only its own user.
195 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
198 if session
["admin"]: # allows all
201 return {"_id.cont": session
["project_id"]}
203 def check_conflict_on_new(self
, session
, indata
):
204 if not indata
.get("name"):
205 raise EngineException("missing 'name'")
206 # check name not exists
209 {"name": indata
.get("name")},
213 raise EngineException(
214 "name '{}' exists".format(indata
["name"]), HTTPStatus
.CONFLICT
218 def format_on_new(content
, project_id
=None, make_public
=False):
219 BaseTopic
.format_on_new(content
, None)
220 # Removed so that the UUID is kept, to allow Project Name modification
221 # content["_id"] = content["name"]
223 def check_conflict_on_del(self
, session
, _id
, db_content
):
225 Check if deletion can be done because of dependencies if it is not force. To override
226 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
227 :param _id: internal _id
228 :param db_content: The database content of this item _id
229 :return: None if ok or raises EngineException with the conflict
231 if _id
in session
["project_id"]:
232 raise EngineException(
233 "You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
237 _filter
= {"projects": _id
}
238 if self
.db
.get_list("users", _filter
):
239 raise EngineException(
240 "There is some USER that contains this project",
241 http_code
=HTTPStatus
.CONFLICT
,
244 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
245 if not session
["admin"]:
246 raise EngineException(
247 "needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
249 # Names that look like UUIDs are not allowed
250 name
= (indata
if indata
else kwargs
).get("name")
251 if is_valid_uuid(name
):
252 raise EngineException(
253 "Project names that look like UUIDs are not allowed",
254 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
,
256 return BaseTopic
.edit(
257 self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
260 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
261 if not session
["admin"]:
262 raise EngineException(
263 "needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
265 # Names that look like UUIDs are not allowed
266 name
= indata
["name"] if indata
else kwargs
["name"]
267 if is_valid_uuid(name
):
268 raise EngineException(
269 "Project names that look like UUIDs are not allowed",
270 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
,
272 return BaseTopic
.new(
273 self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
277 class CommonVimWimSdn(BaseTopic
):
278 """Common class for VIM, WIM SDN just to unify methods that are equal to all of them"""
280 config_to_encrypt
= (
282 ) # what keys at config must be encrypted because contains passwords
283 password_to_encrypt
= "" # key that contains a password
286 def _create_operation(op_type
, params
=None):
288 Creates a dictionary with the information to an operation, similar to ns-lcm-op
289 :param op_type: can be create, edit, delete
290 :param params: operation input parameters
291 :return: new dictionary with
295 "lcmOperationType": op_type
,
296 "operationState": "PROCESSING",
298 "statusEnteredTime": now
,
299 "detailed-status": "",
300 "operationParams": params
,
303 def check_conflict_on_new(self
, session
, indata
):
305 Check that the data to be inserted is valid. It is checked that name is unique
306 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
307 :param indata: data to be inserted
308 :return: None or raises EngineException
310 self
.check_unique_name(session
, indata
["name"], _id
=None)
312 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
314 Check that the data to be edited/uploaded is valid. It is checked that name is unique
315 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
316 :param final_content: data once modified. This method may change it.
317 :param edit_content: incremental data that contains the modifications to apply
318 :param _id: internal _id
319 :return: None or raises EngineException
321 if not session
["force"] and edit_content
.get("name"):
322 self
.check_unique_name(session
, edit_content
["name"], _id
=_id
)
326 def format_on_edit(self
, final_content
, edit_content
):
328 Modifies final_content inserting admin information upon edition
329 :param final_content: final content to be stored at database
330 :param edit_content: user requested update content
331 :return: operation id
333 super().format_on_edit(final_content
, edit_content
)
336 schema_version
= final_content
.get("schema_version")
338 if edit_content
.get(self
.password_to_encrypt
):
339 final_content
[self
.password_to_encrypt
] = self
.db
.encrypt(
340 edit_content
[self
.password_to_encrypt
],
341 schema_version
=schema_version
,
342 salt
=final_content
["_id"],
344 config_to_encrypt_keys
= self
.config_to_encrypt
.get(
346 ) or self
.config_to_encrypt
.get("default")
347 if edit_content
.get("config") and config_to_encrypt_keys
:
348 for p
in config_to_encrypt_keys
:
349 if edit_content
["config"].get(p
):
350 final_content
["config"][p
] = self
.db
.encrypt(
351 edit_content
["config"][p
],
352 schema_version
=schema_version
,
353 salt
=final_content
["_id"],
356 # create edit operation
357 final_content
["_admin"]["operations"].append(self
._create
_operation
("edit"))
358 return "{}:{}".format(
359 final_content
["_id"], len(final_content
["_admin"]["operations"]) - 1
362 def format_on_new(self
, content
, project_id
=None, make_public
=False):
364 Modifies content descriptor to include _admin and insert create operation
365 :param content: descriptor to be modified
366 :param project_id: if included, it add project read/write permissions. Can be None or a list
367 :param make_public: if included it is generated as public for reading.
368 :return: op_id: operation id on asynchronous operation, None otherwise. In addition content is modified
370 super().format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
371 content
["schema_version"] = schema_version
= "1.11"
374 if content
.get(self
.password_to_encrypt
):
375 content
[self
.password_to_encrypt
] = self
.db
.encrypt(
376 content
[self
.password_to_encrypt
],
377 schema_version
=schema_version
,
380 config_to_encrypt_keys
= self
.config_to_encrypt
.get(
382 ) or self
.config_to_encrypt
.get("default")
383 if content
.get("config") and config_to_encrypt_keys
:
384 for p
in config_to_encrypt_keys
:
385 if content
["config"].get(p
):
386 content
["config"][p
] = self
.db
.encrypt(
387 content
["config"][p
],
388 schema_version
=schema_version
,
392 content
["_admin"]["operationalState"] = "PROCESSING"
395 content
["_admin"]["operations"] = [self
._create
_operation
("create")]
396 content
["_admin"]["current_operation"] = None
397 # create Resource in Openstack based VIM
398 if content
.get("vim_type"):
399 if content
["vim_type"] == "openstack":
401 "ram": {"total": None, "used": None},
402 "vcpus": {"total": None, "used": None},
403 "instances": {"total": None, "used": None},
406 "volumes": {"total": None, "used": None},
407 "snapshots": {"total": None, "used": None},
408 "storage": {"total": None, "used": None},
411 "networks": {"total": None, "used": None},
412 "subnets": {"total": None, "used": None},
413 "floating_ips": {"total": None, "used": None},
415 content
["resources"] = {
421 return "{}:0".format(content
["_id"])
423 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
425 Delete item by its internal _id
426 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
427 :param _id: server internal id
428 :param dry_run: make checking but do not delete
429 :param not_send_msg: To not send message (False) or store content (list) instead
430 :return: operation id if it is ordered to delete. None otherwise
433 filter_q
= self
._get
_project
_filter
(session
)
434 filter_q
["_id"] = _id
435 db_content
= self
.db
.get_one(self
.topic
, filter_q
)
437 self
.check_conflict_on_del(session
, _id
, db_content
)
441 # remove reference from project_read if there are more projects referencing it. If it last one,
442 # do not remove reference, but order via kafka to delete it
443 if session
["project_id"]:
444 other_projects_referencing
= next(
447 for p
in db_content
["_admin"]["projects_read"]
448 if p
not in session
["project_id"] and p
!= "ANY"
453 # check if there are projects referencing it (apart from ANY, that means, public)....
454 if other_projects_referencing
:
455 # remove references but not delete
457 "_admin.projects_read": session
["project_id"],
458 "_admin.projects_write": session
["project_id"],
461 self
.topic
, filter_q
, update_dict
=None, pull_list
=update_dict_pull
468 for p
in db_content
["_admin"]["projects_write"]
469 if p
== "ANY" or p
in session
["project_id"]
474 raise EngineException(
475 "You have not write permission to delete it",
476 http_code
=HTTPStatus
.UNAUTHORIZED
,
481 self
.db
.del_one(self
.topic
, {"_id": _id
})
484 "deleted", {"_id": _id
, "op_id": op_id
}, not_send_msg
=not_send_msg
487 update_dict
= {"_admin.to_delete": True}
491 update_dict
=update_dict
,
492 push
={"_admin.operations": self
._create
_operation
("delete")},
494 # the number of operations is the operation_id. db_content does not contains the new operation inserted,
495 # so the -1 is not needed
496 op_id
= "{}:{}".format(
497 db_content
["_id"], len(db_content
["_admin"]["operations"])
500 "delete", {"_id": _id
, "op_id": op_id
}, not_send_msg
=not_send_msg
505 class VimAccountTopic(CommonVimWimSdn
):
506 topic
= "vim_accounts"
507 topic_msg
= "vim_account"
508 schema_new
= vim_account_new_schema
509 schema_edit
= vim_account_edit_schema
511 password_to_encrypt
= "vim_password"
512 config_to_encrypt
= {
513 "1.1": ("admin_password", "nsx_password", "vcenter_password"),
522 def check_conflict_on_del(self
, session
, _id
, db_content
):
524 Check if deletion can be done because of dependencies if it is not force. To override
525 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
526 :param _id: internal _id
527 :param db_content: The database content of this item _id
528 :return: None if ok or raises EngineException with the conflict
532 # check if used by VNF
533 if self
.db
.get_list("vnfrs", {"vim-account-id": _id
}):
534 raise EngineException(
535 "There is at least one VNF using this VIM account",
536 http_code
=HTTPStatus
.CONFLICT
,
538 super().check_conflict_on_del(session
, _id
, db_content
)
541 class WimAccountTopic(CommonVimWimSdn
):
542 topic
= "wim_accounts"
543 topic_msg
= "wim_account"
544 schema_new
= wim_account_new_schema
545 schema_edit
= wim_account_edit_schema
547 password_to_encrypt
= "password"
548 config_to_encrypt
= {}
551 class SdnTopic(CommonVimWimSdn
):
554 quota_name
= "sdn_controllers"
555 schema_new
= sdn_new_schema
556 schema_edit
= sdn_edit_schema
558 password_to_encrypt
= "password"
559 config_to_encrypt
= {}
561 def _obtain_url(self
, input, create
):
562 if input.get("ip") or input.get("port"):
563 if not input.get("ip") or not input.get("port") or input.get("url"):
564 raise ValidationError(
565 "You must provide both 'ip' and 'port' (deprecated); or just 'url' (prefered)"
567 input["url"] = "http://{}:{}/".format(input["ip"], input["port"])
570 elif create
and not input.get("url"):
571 raise ValidationError("You must provide 'url'")
574 def _validate_input_new(self
, input, force
=False):
575 input = super()._validate
_input
_new
(input, force
)
576 return self
._obtain
_url
(input, True)
578 def _validate_input_edit(self
, input, content
, force
=False):
579 input = super()._validate
_input
_edit
(input, content
, force
)
580 return self
._obtain
_url
(input, False)
583 class K8sClusterTopic(CommonVimWimSdn
):
584 topic
= "k8sclusters"
585 topic_msg
= "k8scluster"
586 schema_new
= k8scluster_new_schema
587 schema_edit
= k8scluster_edit_schema
589 password_to_encrypt
= None
590 config_to_encrypt
= {}
592 def format_on_new(self
, content
, project_id
=None, make_public
=False):
593 oid
= super().format_on_new(content
, project_id
, make_public
)
594 self
.db
.encrypt_decrypt_fields(
595 content
["credentials"],
597 ["password", "secret"],
598 schema_version
=content
["schema_version"],
601 # Add Helm/Juju Repo lists
602 repos
= {"helm-chart": [], "juju-bundle": []}
603 for proj
in content
["_admin"]["projects_read"]:
605 for repo
in self
.db
.get_list(
606 "k8srepos", {"_admin.projects_read": proj
}
608 if repo
["_id"] not in repos
[repo
["type"]]:
609 repos
[repo
["type"]].append(repo
["_id"])
611 content
["_admin"][k
.replace("-", "_") + "_repos"] = repos
[k
]
614 def format_on_edit(self
, final_content
, edit_content
):
615 if final_content
.get("schema_version") and edit_content
.get("credentials"):
616 self
.db
.encrypt_decrypt_fields(
617 edit_content
["credentials"],
619 ["password", "secret"],
620 schema_version
=final_content
["schema_version"],
621 salt
=final_content
["_id"],
624 final_content
["credentials"], edit_content
["credentials"]
626 oid
= super().format_on_edit(final_content
, edit_content
)
629 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
630 final_content
= super(CommonVimWimSdn
, self
).check_conflict_on_edit(
631 session
, final_content
, edit_content
, _id
633 final_content
= super().check_conflict_on_edit(
634 session
, final_content
, edit_content
, _id
636 # Update Helm/Juju Repo lists
637 repos
= {"helm-chart": [], "juju-bundle": []}
638 for proj
in session
.get("set_project", []):
640 for repo
in self
.db
.get_list(
641 "k8srepos", {"_admin.projects_read": proj
}
643 if repo
["_id"] not in repos
[repo
["type"]]:
644 repos
[repo
["type"]].append(repo
["_id"])
646 rlist
= k
.replace("-", "_") + "_repos"
647 if rlist
not in final_content
["_admin"]:
648 final_content
["_admin"][rlist
] = []
649 final_content
["_admin"][rlist
] += repos
[k
]
652 def check_conflict_on_del(self
, session
, _id
, db_content
):
654 Check if deletion can be done because of dependencies if it is not force. To override
655 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
656 :param _id: internal _id
657 :param db_content: The database content of this item _id
658 :return: None if ok or raises EngineException with the conflict
662 # check if used by VNF
663 filter_q
= {"kdur.k8s-cluster.id": _id
}
664 if session
["project_id"]:
665 filter_q
["_admin.projects_read.cont"] = session
["project_id"]
666 if self
.db
.get_list("vnfrs", filter_q
):
667 raise EngineException(
668 "There is at least one VNF using this k8scluster",
669 http_code
=HTTPStatus
.CONFLICT
,
671 super().check_conflict_on_del(session
, _id
, db_content
)
674 class VcaTopic(CommonVimWimSdn
):
677 schema_new
= vca_new_schema
678 schema_edit
= vca_edit_schema
680 password_to_encrypt
= None
682 def format_on_new(self
, content
, project_id
=None, make_public
=False):
683 oid
= super().format_on_new(content
, project_id
, make_public
)
684 content
["schema_version"] = schema_version
= "1.11"
685 for key
in ["secret", "cacert"]:
686 content
[key
] = self
.db
.encrypt(
687 content
[key
], schema_version
=schema_version
, salt
=content
["_id"]
691 def format_on_edit(self
, final_content
, edit_content
):
692 oid
= super().format_on_edit(final_content
, edit_content
)
693 schema_version
= final_content
.get("schema_version")
694 for key
in ["secret", "cacert"]:
695 if key
in edit_content
:
696 final_content
[key
] = self
.db
.encrypt(
698 schema_version
=schema_version
,
699 salt
=final_content
["_id"],
703 def check_conflict_on_del(self
, session
, _id
, db_content
):
705 Check if deletion can be done because of dependencies if it is not force. To override
706 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
707 :param _id: internal _id
708 :param db_content: The database content of this item _id
709 :return: None if ok or raises EngineException with the conflict
713 # check if used by VNF
714 filter_q
= {"vca": _id
}
715 if session
["project_id"]:
716 filter_q
["_admin.projects_read.cont"] = session
["project_id"]
717 if self
.db
.get_list("vim_accounts", filter_q
):
718 raise EngineException(
719 "There is at least one VIM account using this vca",
720 http_code
=HTTPStatus
.CONFLICT
,
722 super().check_conflict_on_del(session
, _id
, db_content
)
725 class K8sRepoTopic(CommonVimWimSdn
):
727 topic_msg
= "k8srepo"
728 schema_new
= k8srepo_new_schema
729 schema_edit
= k8srepo_edit_schema
731 password_to_encrypt
= None
732 config_to_encrypt
= {}
734 def format_on_new(self
, content
, project_id
=None, make_public
=False):
735 oid
= super().format_on_new(content
, project_id
, make_public
)
736 # Update Helm/Juju Repo lists
737 repo_list
= content
["type"].replace("-", "_") + "_repos"
738 for proj
in content
["_admin"]["projects_read"]:
743 "_admin.projects_read": proj
,
744 "_admin." + repo_list
+ ".ne": content
["_id"],
747 push
={"_admin." + repo_list
: content
["_id"]},
751 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
752 type = self
.db
.get_one("k8srepos", {"_id": _id
})["type"]
753 oid
= super().delete(session
, _id
, dry_run
, not_send_msg
)
755 # Remove from Helm/Juju Repo lists
756 repo_list
= type.replace("-", "_") + "_repos"
759 {"_admin." + repo_list
: _id
},
761 pull
={"_admin." + repo_list
: _id
},
766 class OsmRepoTopic(BaseTopic
):
768 topic_msg
= "osmrepos"
769 schema_new
= osmrepo_new_schema
770 schema_edit
= osmrepo_edit_schema
772 # TODO: Implement user/password
775 class UserTopicAuth(UserTopic
):
778 schema_new
= user_new_schema
779 schema_edit
= user_edit_schema
781 def __init__(self
, db
, fs
, msg
, auth
):
782 UserTopic
.__init
__(self
, db
, fs
, msg
, auth
)
785 def check_conflict_on_new(self
, session
, indata
):
787 Check that the data to be inserted is valid
789 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
790 :param indata: data to be inserted
791 :return: None or raises EngineException
793 username
= indata
.get("username")
794 if is_valid_uuid(username
):
795 raise EngineException(
796 "username '{}' cannot have a uuid format".format(username
),
797 HTTPStatus
.UNPROCESSABLE_ENTITY
,
800 # Check that username is not used, regardless keystone already checks this
801 if self
.auth
.get_user_list(filter_q
={"name": username
}):
802 raise EngineException(
803 "username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
806 if "projects" in indata
.keys():
807 # convert to new format project_role_mappings
808 role
= self
.auth
.get_role_list({"name": "project_admin"})
810 role
= self
.auth
.get_role_list()
812 raise AuthconnNotFoundException(
813 "Can't find default role for user '{}'".format(username
)
816 if not indata
.get("project_role_mappings"):
817 indata
["project_role_mappings"] = []
818 for project
in indata
["projects"]:
819 pid
= self
.auth
.get_project(project
)["_id"]
820 prm
= {"project": pid
, "role": rid
}
821 if prm
not in indata
["project_role_mappings"]:
822 indata
["project_role_mappings"].append(prm
)
823 # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
824 # HTTPStatus.BAD_REQUEST)
826 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
828 Check that the data to be edited/uploaded is valid
830 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
831 :param final_content: data once modified
832 :param edit_content: incremental data that contains the modifications to apply
833 :param _id: internal _id
834 :return: None or raises EngineException
837 if "username" in edit_content
:
838 username
= edit_content
.get("username")
839 if is_valid_uuid(username
):
840 raise EngineException(
841 "username '{}' cannot have an uuid format".format(username
),
842 HTTPStatus
.UNPROCESSABLE_ENTITY
,
845 # Check that username is not used, regardless keystone already checks this
846 if self
.auth
.get_user_list(filter_q
={"name": username
}):
847 raise EngineException(
848 "username '{}' is already used".format(username
),
852 if final_content
["username"] == "admin":
853 for mapping
in edit_content
.get("remove_project_role_mappings", ()):
854 if mapping
["project"] == "admin" and mapping
.get("role") in (
858 # TODO make this also available for project id and role id
859 raise EngineException(
860 "You cannot remove system_admin role from admin user",
861 http_code
=HTTPStatus
.FORBIDDEN
,
866 def check_conflict_on_del(self
, session
, _id
, db_content
):
868 Check if deletion can be done because of dependencies if it is not force. To override
869 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
870 :param _id: internal _id
871 :param db_content: The database content of this item _id
872 :return: None if ok or raises EngineException with the conflict
874 if db_content
["username"] == session
["username"]:
875 raise EngineException(
876 "You cannot delete your own login user ", http_code
=HTTPStatus
.CONFLICT
878 # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
881 def format_on_show(content
):
883 Modifies the content of the role information to separate the role
884 metadata from the role definition.
886 project_role_mappings
= []
888 if "projects" in content
:
889 for project
in content
["projects"]:
890 for role
in project
["roles"]:
891 project_role_mappings
.append(
893 "project": project
["_id"],
894 "project_name": project
["name"],
896 "role_name": role
["name"],
899 del content
["projects"]
900 content
["project_role_mappings"] = project_role_mappings
904 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
906 Creates a new entry into the authentication backend.
908 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
910 :param rollback: list to append created items at database in case a rollback may to be done
911 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
912 :param indata: data to be inserted
913 :param kwargs: used to override the indata descriptor
914 :param headers: http request headers
915 :return: _id: identity of the inserted data, operation _id (None)
918 content
= BaseTopic
._remove
_envelop
(indata
)
920 # Override descriptor with query string kwargs
921 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
922 content
= self
._validate
_input
_new
(content
, session
["force"])
923 self
.check_conflict_on_new(session
, content
)
924 # self.format_on_new(content, session["project_id"], make_public=session["public"])
926 content
["_admin"] = {"created": now
, "modified": now
}
928 for prm
in content
.get("project_role_mappings", []):
929 proj
= self
.auth
.get_project(prm
["project"], not session
["force"])
930 role
= self
.auth
.get_role(prm
["role"], not session
["force"])
931 pid
= proj
["_id"] if proj
else None
932 rid
= role
["_id"] if role
else None
933 prl
= {"project": pid
, "role": rid
}
936 content
["project_role_mappings"] = prms
937 # _id = self.auth.create_user(content["username"], content["password"])["_id"]
938 _id
= self
.auth
.create_user(content
)["_id"]
940 rollback
.append({"topic": self
.topic
, "_id": _id
})
941 # del content["password"]
942 self
._send
_msg
("created", content
, not_send_msg
=None)
944 except ValidationError
as e
:
945 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
947 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
949 Get complete information on an topic
951 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
952 :param _id: server internal id or username
953 :param filter_q: dict: query parameter
954 :param api_req: True if this call is serving an external API request. False if serving internal request.
955 :return: dictionary, raise exception if not found.
957 # Allow _id to be a name or uuid
958 filter_q
= {"username": _id
}
959 # users = self.auth.get_user_list(filter_q)
960 users
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
964 raise EngineException(
965 "Too many users found for '{}'".format(_id
), HTTPStatus
.CONFLICT
968 raise EngineException(
969 "User '{}' not found".format(_id
), HTTPStatus
.NOT_FOUND
972 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
974 Updates an user entry.
976 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
978 :param indata: data to be inserted
979 :param kwargs: used to override the indata descriptor
981 :return: _id: identity of the inserted data.
983 indata
= self
._remove
_envelop
(indata
)
985 # Override descriptor with query string kwargs
987 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
990 content
= self
.show(session
, _id
)
991 indata
= self
._validate
_input
_edit
(indata
, content
, force
=session
["force"])
992 content
= self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
993 # self.format_on_edit(content, indata)
997 or "username" in indata
998 or indata
.get("remove_project_role_mappings")
999 or indata
.get("add_project_role_mappings")
1000 or indata
.get("project_role_mappings")
1001 or indata
.get("projects")
1002 or indata
.get("add_projects")
1003 or indata
.get("unlock")
1004 or indata
.get("renew")
1007 if indata
.get("project_role_mappings") and (
1008 indata
.get("remove_project_role_mappings")
1009 or indata
.get("add_project_role_mappings")
1011 raise EngineException(
1012 "Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
1013 "' or 'remove_project_role_mappings'",
1014 http_code
=HTTPStatus
.BAD_REQUEST
,
1017 if indata
.get("projects") or indata
.get("add_projects"):
1018 role
= self
.auth
.get_role_list({"name": "project_admin"})
1020 role
= self
.auth
.get_role_list()
1022 raise AuthconnNotFoundException(
1023 "Can't find a default role for user '{}'".format(
1027 rid
= role
[0]["_id"]
1028 if "add_project_role_mappings" not in indata
:
1029 indata
["add_project_role_mappings"] = []
1030 if "remove_project_role_mappings" not in indata
:
1031 indata
["remove_project_role_mappings"] = []
1032 if isinstance(indata
.get("projects"), dict):
1033 # backward compatible
1034 for k
, v
in indata
["projects"].items():
1035 if k
.startswith("$") and v
is None:
1036 indata
["remove_project_role_mappings"].append(
1039 elif k
.startswith("$+"):
1040 indata
["add_project_role_mappings"].append(
1041 {"project": v
, "role": rid
}
1043 del indata
["projects"]
1044 for proj
in indata
.get("projects", []) + indata
.get("add_projects", []):
1045 indata
["add_project_role_mappings"].append(
1046 {"project": proj
, "role": rid
}
1049 # user = self.show(session, _id) # Already in 'content'
1050 original_mapping
= content
["project_role_mappings"]
1052 mappings_to_add
= []
1053 mappings_to_remove
= []
1056 for to_remove
in indata
.get("remove_project_role_mappings", ()):
1057 for mapping
in original_mapping
:
1058 if to_remove
["project"] in (
1060 mapping
["project_name"],
1062 if not to_remove
.get("role") or to_remove
["role"] in (
1064 mapping
["role_name"],
1066 mappings_to_remove
.append(mapping
)
1069 for to_add
in indata
.get("add_project_role_mappings", ()):
1070 for mapping
in original_mapping
:
1071 if to_add
["project"] in (
1073 mapping
["project_name"],
1074 ) and to_add
["role"] in (
1076 mapping
["role_name"],
1078 if mapping
in mappings_to_remove
: # do not remove
1079 mappings_to_remove
.remove(mapping
)
1080 break # do not add, it is already at user
1082 pid
= self
.auth
.get_project(to_add
["project"])["_id"]
1083 rid
= self
.auth
.get_role(to_add
["role"])["_id"]
1084 mappings_to_add
.append({"project": pid
, "role": rid
})
1087 if indata
.get("project_role_mappings"):
1088 for to_set
in indata
["project_role_mappings"]:
1089 for mapping
in original_mapping
:
1090 if to_set
["project"] in (
1092 mapping
["project_name"],
1093 ) and to_set
["role"] in (
1095 mapping
["role_name"],
1097 if mapping
in mappings_to_remove
: # do not remove
1098 mappings_to_remove
.remove(mapping
)
1099 break # do not add, it is already at user
1101 pid
= self
.auth
.get_project(to_set
["project"])["_id"]
1102 rid
= self
.auth
.get_role(to_set
["role"])["_id"]
1103 mappings_to_add
.append({"project": pid
, "role": rid
})
1104 for mapping
in original_mapping
:
1105 for to_set
in indata
["project_role_mappings"]:
1106 if to_set
["project"] in (
1108 mapping
["project_name"],
1109 ) and to_set
["role"] in (
1111 mapping
["role_name"],
1116 if mapping
not in mappings_to_remove
: # do not remove
1117 mappings_to_remove
.append(mapping
)
1119 self
.auth
.update_user(
1122 "username": indata
.get("username"),
1123 "password": indata
.get("password"),
1124 "old_password": indata
.get("old_password"),
1125 "add_project_role_mappings": mappings_to_add
,
1126 "remove_project_role_mappings": mappings_to_remove
,
1127 "system_admin_id": indata
.get("system_admin_id"),
1128 "unlock": indata
.get("unlock"),
1129 "renew": indata
.get("renew"),
1132 data_to_send
= {"_id": _id
, "changes": indata
}
1133 self
._send
_msg
("edited", data_to_send
, not_send_msg
=None)
1136 except ValidationError
as e
:
1137 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1139 def list(self
, session
, filter_q
=None, api_req
=False):
1141 Get a list of the topic that matches a filter
1142 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1143 :param filter_q: filter of data to be applied
1144 :param api_req: True if this call is serving an external API request. False if serving internal request.
1145 :return: The list, it can be empty if no one match the filter.
1147 user_list
= self
.auth
.get_user_list(filter_q
)
1148 if not session
["allow_show_user_project_role"]:
1149 # Bug 853 - Default filtering
1151 usr
for usr
in user_list
if usr
["username"] == session
["username"]
1155 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1157 Delete item by its internal _id
1159 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1160 :param _id: server internal id
1161 :param force: indicates if deletion must be forced in case of conflict
1162 :param dry_run: make checking but do not delete
1163 :param not_send_msg: To not send message (False) or store content (list) instead
1164 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1166 # Allow _id to be a name or uuid
1167 user
= self
.auth
.get_user(_id
)
1169 self
.check_conflict_on_del(session
, uid
, user
)
1171 v
= self
.auth
.delete_user(uid
)
1172 self
._send
_msg
("deleted", user
, not_send_msg
=not_send_msg
)
1177 class ProjectTopicAuth(ProjectTopic
):
1178 # topic = "projects"
1179 topic_msg
= "project"
1180 schema_new
= project_new_schema
1181 schema_edit
= project_edit_schema
1183 def __init__(self
, db
, fs
, msg
, auth
):
1184 ProjectTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1187 def check_conflict_on_new(self
, session
, indata
):
1189 Check that the data to be inserted is valid
1191 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1192 :param indata: data to be inserted
1193 :return: None or raises EngineException
1195 project_name
= indata
.get("name")
1196 if is_valid_uuid(project_name
):
1197 raise EngineException(
1198 "project name '{}' cannot have an uuid format".format(project_name
),
1199 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1202 project_list
= self
.auth
.get_project_list(filter_q
={"name": project_name
})
1205 raise EngineException(
1206 "project '{}' exists".format(project_name
), HTTPStatus
.CONFLICT
1209 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
1211 Check that the data to be edited/uploaded is valid
1213 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1214 :param final_content: data once modified
1215 :param edit_content: incremental data that contains the modifications to apply
1216 :param _id: internal _id
1217 :return: None or raises EngineException
1220 project_name
= edit_content
.get("name")
1221 if project_name
!= final_content
["name"]: # It is a true renaming
1222 if is_valid_uuid(project_name
):
1223 raise EngineException(
1224 "project name '{}' cannot have an uuid format".format(project_name
),
1225 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1228 if final_content
["name"] == "admin":
1229 raise EngineException(
1230 "You cannot rename project 'admin'", http_code
=HTTPStatus
.CONFLICT
1233 # Check that project name is not used, regardless keystone already checks this
1234 if project_name
and self
.auth
.get_project_list(
1235 filter_q
={"name": project_name
}
1237 raise EngineException(
1238 "project '{}' is already used".format(project_name
),
1239 HTTPStatus
.CONFLICT
,
1241 return final_content
1243 def check_conflict_on_del(self
, session
, _id
, db_content
):
1245 Check if deletion can be done because of dependencies if it is not force. To override
1247 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1248 :param _id: internal _id
1249 :param db_content: The database content of this item _id
1250 :return: None if ok or raises EngineException with the conflict
1253 def check_rw_projects(topic
, title
, id_field
):
1254 for desc
in self
.db
.get_list(topic
):
1257 in desc
["_admin"]["projects_read"]
1258 + desc
["_admin"]["projects_write"]
1260 raise EngineException(
1261 "Project '{}' ({}) is being used by {} '{}'".format(
1262 db_content
["name"], _id
, title
, desc
[id_field
]
1264 HTTPStatus
.CONFLICT
,
1267 if _id
in session
["project_id"]:
1268 raise EngineException(
1269 "You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
1272 if db_content
["name"] == "admin":
1273 raise EngineException(
1274 "You cannot delete project 'admin'", http_code
=HTTPStatus
.CONFLICT
1277 # If any user is using this project, raise CONFLICT exception
1278 if not session
["force"]:
1279 for user
in self
.auth
.get_user_list():
1280 for prm
in user
.get("project_role_mappings"):
1281 if prm
["project"] == _id
:
1282 raise EngineException(
1283 "Project '{}' ({}) is being used by user '{}'".format(
1284 db_content
["name"], _id
, user
["username"]
1286 HTTPStatus
.CONFLICT
,
1289 # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
1290 if not session
["force"]:
1291 check_rw_projects("vnfds", "VNF Descriptor", "id")
1292 check_rw_projects("nsds", "NS Descriptor", "id")
1293 check_rw_projects("nsts", "NS Template", "id")
1294 check_rw_projects("pdus", "PDU Descriptor", "name")
1296 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1298 Creates a new entry into the authentication backend.
1300 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
1302 :param rollback: list to append created items at database in case a rollback may to be done
1303 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1304 :param indata: data to be inserted
1305 :param kwargs: used to override the indata descriptor
1306 :param headers: http request headers
1307 :return: _id: identity of the inserted data, operation _id (None)
1310 content
= BaseTopic
._remove
_envelop
(indata
)
1312 # Override descriptor with query string kwargs
1313 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
1314 content
= self
._validate
_input
_new
(content
, session
["force"])
1315 self
.check_conflict_on_new(session
, content
)
1317 content
, project_id
=session
["project_id"], make_public
=session
["public"]
1319 _id
= self
.auth
.create_project(content
)
1320 rollback
.append({"topic": self
.topic
, "_id": _id
})
1321 self
._send
_msg
("created", content
, not_send_msg
=None)
1323 except ValidationError
as e
:
1324 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1326 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
1328 Get complete information on an topic
1330 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1331 :param _id: server internal id
1332 :param filter_q: dict: query parameter
1333 :param api_req: True if this call is serving an external API request. False if serving internal request.
1334 :return: dictionary, raise exception if not found.
1336 # Allow _id to be a name or uuid
1337 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
1338 # projects = self.auth.get_project_list(filter_q=filter_q)
1339 projects
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
1340 if len(projects
) == 1:
1342 elif len(projects
) > 1:
1343 raise EngineException("Too many projects found", HTTPStatus
.CONFLICT
)
1345 raise EngineException("Project not found", HTTPStatus
.NOT_FOUND
)
1347 def list(self
, session
, filter_q
=None, api_req
=False):
1349 Get a list of the topic that matches a filter
1351 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1352 :param filter_q: filter of data to be applied
1353 :return: The list, it can be empty if no one match the filter.
1355 project_list
= self
.auth
.get_project_list(filter_q
)
1356 if not session
["allow_show_user_project_role"]:
1357 # Bug 853 - Default filtering
1358 user
= self
.auth
.get_user(session
["username"])
1359 projects
= [prm
["project"] for prm
in user
["project_role_mappings"]]
1360 project_list
= [proj
for proj
in project_list
if proj
["_id"] in projects
]
1363 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1365 Delete item by its internal _id
1367 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1368 :param _id: server internal id
1369 :param dry_run: make checking but do not delete
1370 :param not_send_msg: To not send message (False) or store content (list) instead
1371 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1373 # Allow _id to be a name or uuid
1374 proj
= self
.auth
.get_project(_id
)
1376 self
.check_conflict_on_del(session
, pid
, proj
)
1378 v
= self
.auth
.delete_project(pid
)
1379 self
._send
_msg
("deleted", proj
, not_send_msg
=None)
1383 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1385 Updates a project entry.
1387 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1389 :param indata: data to be inserted
1390 :param kwargs: used to override the indata descriptor
1392 :return: _id: identity of the inserted data.
1394 indata
= self
._remove
_envelop
(indata
)
1396 # Override descriptor with query string kwargs
1398 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
1401 content
= self
.show(session
, _id
)
1402 indata
= self
._validate
_input
_edit
(indata
, content
, force
=session
["force"])
1403 content
= self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1404 self
.format_on_edit(content
, indata
)
1405 content_original
= copy
.deepcopy(content
)
1406 deep_update_rfc7396(content
, indata
)
1407 self
.auth
.update_project(content
["_id"], content
)
1408 proj_data
= {"_id": _id
, "changes": indata
, "original": content_original
}
1409 self
._send
_msg
("edited", proj_data
, not_send_msg
=None)
1410 except ValidationError
as e
:
1411 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1414 class RoleTopicAuth(BaseTopic
):
1416 topic_msg
= None # "roles"
1417 schema_new
= roles_new_schema
1418 schema_edit
= roles_edit_schema
1419 multiproject
= False
1421 def __init__(self
, db
, fs
, msg
, auth
):
1422 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1424 self
.operations
= auth
.role_permissions
1425 # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
1428 def validate_role_definition(operations
, role_definitions
):
1430 Validates the role definition against the operations defined in
1431 the resources to operations files.
1433 :param operations: operations list
1434 :param role_definitions: role definition to test
1435 :return: None if ok, raises ValidationError exception on error
1437 if not role_definitions
.get("permissions"):
1439 ignore_fields
= ["admin", "default"]
1440 for role_def
in role_definitions
["permissions"].keys():
1441 if role_def
in ignore_fields
:
1443 if role_def
[-1] == ":":
1444 raise ValidationError("Operation cannot end with ':'")
1449 for op
in operations
1450 if op
== role_def
or op
.startswith(role_def
+ ":")
1456 raise ValidationError("Invalid permission '{}'".format(role_def
))
1458 def _validate_input_new(self
, input, force
=False):
1460 Validates input user content for a new entry.
1462 :param input: user input content for the new topic
1463 :param force: may be used for being more tolerant
1464 :return: The same input content, or a changed version of it.
1467 validate_input(input, self
.schema_new
)
1468 self
.validate_role_definition(self
.operations
, input)
1472 def _validate_input_edit(self
, input, content
, force
=False):
1474 Validates input user content for updating an entry.
1476 :param input: user input content for the new topic
1477 :param force: may be used for being more tolerant
1478 :return: The same input content, or a changed version of it.
1480 if self
.schema_edit
:
1481 validate_input(input, self
.schema_edit
)
1482 self
.validate_role_definition(self
.operations
, input)
1486 def check_conflict_on_new(self
, session
, indata
):
1488 Check that the data to be inserted is valid
1490 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1491 :param indata: data to be inserted
1492 :return: None or raises EngineException
1494 # check name is not uuid
1495 role_name
= indata
.get("name")
1496 if is_valid_uuid(role_name
):
1497 raise EngineException(
1498 "role name '{}' cannot have an uuid format".format(role_name
),
1499 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1501 # check name not exists
1502 name
= indata
["name"]
1503 # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
1504 if self
.auth
.get_role_list({"name": name
}):
1505 raise EngineException(
1506 "role name '{}' exists".format(name
), HTTPStatus
.CONFLICT
1509 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
1511 Check that the data to be edited/uploaded is valid
1513 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1514 :param final_content: data once modified
1515 :param edit_content: incremental data that contains the modifications to apply
1516 :param _id: internal _id
1517 :return: None or raises EngineException
1519 if "default" not in final_content
["permissions"]:
1520 final_content
["permissions"]["default"] = False
1521 if "admin" not in final_content
["permissions"]:
1522 final_content
["permissions"]["admin"] = False
1524 # check name is not uuid
1525 role_name
= edit_content
.get("name")
1526 if is_valid_uuid(role_name
):
1527 raise EngineException(
1528 "role name '{}' cannot have an uuid format".format(role_name
),
1529 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1532 # Check renaming of admin roles
1533 role
= self
.auth
.get_role(_id
)
1534 if role
["name"] in ["system_admin", "project_admin"]:
1535 raise EngineException(
1536 "You cannot rename role '{}'".format(role
["name"]),
1537 http_code
=HTTPStatus
.FORBIDDEN
,
1540 # check name not exists
1541 if "name" in edit_content
:
1542 role_name
= edit_content
["name"]
1543 # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
1544 roles
= self
.auth
.get_role_list({"name": role_name
})
1545 if roles
and roles
[0][BaseTopic
.id_field("roles", _id
)] != _id
:
1546 raise EngineException(
1547 "role name '{}' exists".format(role_name
), HTTPStatus
.CONFLICT
1550 return final_content
1552 def check_conflict_on_del(self
, session
, _id
, db_content
):
1554 Check if deletion can be done because of dependencies if it is not force. To override
1556 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1557 :param _id: internal _id
1558 :param db_content: The database content of this item _id
1559 :return: None if ok or raises EngineException with the conflict
1561 role
= self
.auth
.get_role(_id
)
1562 if role
["name"] in ["system_admin", "project_admin"]:
1563 raise EngineException(
1564 "You cannot delete role '{}'".format(role
["name"]),
1565 http_code
=HTTPStatus
.FORBIDDEN
,
1568 # If any user is using this role, raise CONFLICT exception
1569 if not session
["force"]:
1570 for user
in self
.auth
.get_user_list():
1571 for prm
in user
.get("project_role_mappings"):
1572 if prm
["role"] == _id
:
1573 raise EngineException(
1574 "Role '{}' ({}) is being used by user '{}'".format(
1575 role
["name"], _id
, user
["username"]
1577 HTTPStatus
.CONFLICT
,
1581 def format_on_new(content
, project_id
=None, make_public
=False): # TO BE REMOVED ?
1583 Modifies content descriptor to include _admin
1585 :param content: descriptor to be modified
1586 :param project_id: if included, it add project read/write permissions
1587 :param make_public: if included it is generated as public for reading.
1588 :return: None, but content is modified
1591 if "_admin" not in content
:
1592 content
["_admin"] = {}
1593 if not content
["_admin"].get("created"):
1594 content
["_admin"]["created"] = now
1595 content
["_admin"]["modified"] = now
1597 if "permissions" not in content
:
1598 content
["permissions"] = {}
1600 if "default" not in content
["permissions"]:
1601 content
["permissions"]["default"] = False
1602 if "admin" not in content
["permissions"]:
1603 content
["permissions"]["admin"] = False
1606 def format_on_edit(final_content
, edit_content
):
1608 Modifies final_content descriptor to include the modified date.
1610 :param final_content: final descriptor generated
1611 :param edit_content: alterations to be include
1612 :return: None, but final_content is modified
1614 if "_admin" in final_content
:
1615 final_content
["_admin"]["modified"] = time()
1617 if "permissions" not in final_content
:
1618 final_content
["permissions"] = {}
1620 if "default" not in final_content
["permissions"]:
1621 final_content
["permissions"]["default"] = False
1622 if "admin" not in final_content
["permissions"]:
1623 final_content
["permissions"]["admin"] = False
1626 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
1628 Get complete information on an topic
1630 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1631 :param _id: server internal id
1632 :param filter_q: dict: query parameter
1633 :param api_req: True if this call is serving an external API request. False if serving internal request.
1634 :return: dictionary, raise exception if not found.
1636 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1637 # roles = self.auth.get_role_list(filter_q)
1638 roles
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
1640 raise AuthconnNotFoundException(
1641 "Not found any role with filter {}".format(filter_q
)
1643 elif len(roles
) > 1:
1644 raise AuthconnConflictException(
1645 "Found more than one role with filter {}".format(filter_q
)
1649 def list(self
, session
, filter_q
=None, api_req
=False):
1651 Get a list of the topic that matches a filter
1653 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1654 :param filter_q: filter of data to be applied
1655 :return: The list, it can be empty if no one match the filter.
1657 role_list
= self
.auth
.get_role_list(filter_q
)
1658 if not session
["allow_show_user_project_role"]:
1659 # Bug 853 - Default filtering
1660 user
= self
.auth
.get_user(session
["username"])
1661 roles
= [prm
["role"] for prm
in user
["project_role_mappings"]]
1662 role_list
= [role
for role
in role_list
if role
["_id"] in roles
]
1665 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1667 Creates a new entry into database.
1669 :param rollback: list to append created items at database in case a rollback may to be done
1670 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1671 :param indata: data to be inserted
1672 :param kwargs: used to override the indata descriptor
1673 :param headers: http request headers
1674 :return: _id: identity of the inserted data, operation _id (None)
1677 content
= self
._remove
_envelop
(indata
)
1679 # Override descriptor with query string kwargs
1680 self
._update
_input
_with
_kwargs
(content
, kwargs
)
1681 content
= self
._validate
_input
_new
(content
, session
["force"])
1682 self
.check_conflict_on_new(session
, content
)
1684 content
, project_id
=session
["project_id"], make_public
=session
["public"]
1686 # role_name = content["name"]
1687 rid
= self
.auth
.create_role(content
)
1688 content
["_id"] = rid
1689 # _id = self.db.create(self.topic, content)
1690 rollback
.append({"topic": self
.topic
, "_id": rid
})
1691 # self._send_msg("created", content, not_send_msg=not_send_msg)
1693 except ValidationError
as e
:
1694 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1696 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1698 Delete item by its internal _id
1700 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1701 :param _id: server internal id
1702 :param dry_run: make checking but do not delete
1703 :param not_send_msg: To not send message (False) or store content (list) instead
1704 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1706 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1707 roles
= self
.auth
.get_role_list(filter_q
)
1709 raise AuthconnNotFoundException(
1710 "Not found any role with filter {}".format(filter_q
)
1712 elif len(roles
) > 1:
1713 raise AuthconnConflictException(
1714 "Found more than one role with filter {}".format(filter_q
)
1716 rid
= roles
[0]["_id"]
1717 self
.check_conflict_on_del(session
, rid
, None)
1718 # filter_q = {"_id": _id}
1719 # filter_q = {BaseTopic.id_field(self.topic, _id): _id} # To allow role addressing by name
1721 v
= self
.auth
.delete_role(rid
)
1722 # v = self.db.del_one(self.topic, filter_q)
1726 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1728 Updates a role entry.
1730 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1732 :param indata: data to be inserted
1733 :param kwargs: used to override the indata descriptor
1735 :return: _id: identity of the inserted data.
1738 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1741 content
= self
.show(session
, _id
)
1742 indata
= self
._validate
_input
_edit
(indata
, content
, force
=session
["force"])
1743 deep_update_rfc7396(content
, indata
)
1744 content
= self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1745 self
.format_on_edit(content
, indata
)
1746 self
.auth
.update_role(content
)
1747 except ValidationError
as e
:
1748 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)