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
:
349 for p
in config_to_encrypt_keys
:
350 if edit_content
["config"].get(p
):
351 final_content
["config"][p
] = self
.db
.encrypt(
352 edit_content
["config"][p
],
353 schema_version
=schema_version
,
354 salt
=final_content
["_id"],
357 # create edit operation
358 final_content
["_admin"]["operations"].append(self
._create
_operation
("edit"))
359 return "{}:{}".format(
360 final_content
["_id"], len(final_content
["_admin"]["operations"]) - 1
363 def format_on_new(self
, content
, project_id
=None, make_public
=False):
365 Modifies content descriptor to include _admin and insert create operation
366 :param content: descriptor to be modified
367 :param project_id: if included, it add project read/write permissions. Can be None or a list
368 :param make_public: if included it is generated as public for reading.
369 :return: op_id: operation id on asynchronous operation, None otherwise. In addition content is modified
371 super().format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
372 content
["schema_version"] = schema_version
= "1.11"
375 if content
.get(self
.password_to_encrypt
):
376 content
[self
.password_to_encrypt
] = self
.db
.encrypt(
377 content
[self
.password_to_encrypt
],
378 schema_version
=schema_version
,
381 config_to_encrypt_keys
= self
.config_to_encrypt
.get(
383 ) or self
.config_to_encrypt
.get("default")
384 if content
.get("config") and config_to_encrypt_keys
:
385 for p
in config_to_encrypt_keys
:
386 if content
["config"].get(p
):
387 content
["config"][p
] = self
.db
.encrypt(
388 content
["config"][p
],
389 schema_version
=schema_version
,
393 content
["_admin"]["operationalState"] = "PROCESSING"
396 content
["_admin"]["operations"] = [self
._create
_operation
("create")]
397 content
["_admin"]["current_operation"] = None
399 return "{}:0".format(content
["_id"])
401 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
403 Delete item by its internal _id
404 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
405 :param _id: server internal id
406 :param dry_run: make checking but do not delete
407 :param not_send_msg: To not send message (False) or store content (list) instead
408 :return: operation id if it is ordered to delete. None otherwise
411 filter_q
= self
._get
_project
_filter
(session
)
412 filter_q
["_id"] = _id
413 db_content
= self
.db
.get_one(self
.topic
, filter_q
)
415 self
.check_conflict_on_del(session
, _id
, db_content
)
419 # remove reference from project_read if there are more projects referencing it. If it last one,
420 # do not remove reference, but order via kafka to delete it
421 if session
["project_id"] and session
["project_id"]:
422 other_projects_referencing
= next(
425 for p
in db_content
["_admin"]["projects_read"]
426 if p
not in session
["project_id"] and p
!= "ANY"
431 # check if there are projects referencing it (apart from ANY, that means, public)....
432 if other_projects_referencing
:
433 # remove references but not delete
435 "_admin.projects_read": session
["project_id"],
436 "_admin.projects_write": session
["project_id"],
439 self
.topic
, filter_q
, update_dict
=None, pull_list
=update_dict_pull
446 for p
in db_content
["_admin"]["projects_write"]
447 if p
== "ANY" or p
in session
["project_id"]
452 raise EngineException(
453 "You have not write permission to delete it",
454 http_code
=HTTPStatus
.UNAUTHORIZED
,
459 self
.db
.del_one(self
.topic
, {"_id": _id
})
462 "deleted", {"_id": _id
, "op_id": op_id
}, not_send_msg
=not_send_msg
465 update_dict
= {"_admin.to_delete": True}
469 update_dict
=update_dict
,
470 push
={"_admin.operations": self
._create
_operation
("delete")},
472 # the number of operations is the operation_id. db_content does not contains the new operation inserted,
473 # so the -1 is not needed
474 op_id
= "{}:{}".format(
475 db_content
["_id"], len(db_content
["_admin"]["operations"])
478 "delete", {"_id": _id
, "op_id": op_id
}, not_send_msg
=not_send_msg
483 class VimAccountTopic(CommonVimWimSdn
):
484 topic
= "vim_accounts"
485 topic_msg
= "vim_account"
486 schema_new
= vim_account_new_schema
487 schema_edit
= vim_account_edit_schema
489 password_to_encrypt
= "vim_password"
490 config_to_encrypt
= {
491 "1.1": ("admin_password", "nsx_password", "vcenter_password"),
500 def check_conflict_on_del(self
, session
, _id
, db_content
):
502 Check if deletion can be done because of dependencies if it is not force. To override
503 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
504 :param _id: internal _id
505 :param db_content: The database content of this item _id
506 :return: None if ok or raises EngineException with the conflict
510 # check if used by VNF
511 if self
.db
.get_list("vnfrs", {"vim-account-id": _id
}):
512 raise EngineException(
513 "There is at least one VNF using this VIM account",
514 http_code
=HTTPStatus
.CONFLICT
,
516 super().check_conflict_on_del(session
, _id
, db_content
)
519 class WimAccountTopic(CommonVimWimSdn
):
520 topic
= "wim_accounts"
521 topic_msg
= "wim_account"
522 schema_new
= wim_account_new_schema
523 schema_edit
= wim_account_edit_schema
525 password_to_encrypt
= "wim_password"
526 config_to_encrypt
= {}
529 class SdnTopic(CommonVimWimSdn
):
532 quota_name
= "sdn_controllers"
533 schema_new
= sdn_new_schema
534 schema_edit
= sdn_edit_schema
536 password_to_encrypt
= "password"
537 config_to_encrypt
= {}
539 def _obtain_url(self
, input, create
):
540 if input.get("ip") or input.get("port"):
541 if not input.get("ip") or not input.get("port") or input.get("url"):
542 raise ValidationError(
543 "You must provide both 'ip' and 'port' (deprecated); or just 'url' (prefered)"
545 input["url"] = "http://{}:{}/".format(input["ip"], input["port"])
548 elif create
and not input.get("url"):
549 raise ValidationError("You must provide 'url'")
552 def _validate_input_new(self
, input, force
=False):
553 input = super()._validate
_input
_new
(input, force
)
554 return self
._obtain
_url
(input, True)
556 def _validate_input_edit(self
, input, content
, force
=False):
557 input = super()._validate
_input
_edit
(input, content
, force
)
558 return self
._obtain
_url
(input, False)
561 class K8sClusterTopic(CommonVimWimSdn
):
562 topic
= "k8sclusters"
563 topic_msg
= "k8scluster"
564 schema_new
= k8scluster_new_schema
565 schema_edit
= k8scluster_edit_schema
567 password_to_encrypt
= None
568 config_to_encrypt
= {}
570 def format_on_new(self
, content
, project_id
=None, make_public
=False):
571 oid
= super().format_on_new(content
, project_id
, make_public
)
572 self
.db
.encrypt_decrypt_fields(
573 content
["credentials"],
575 ["password", "secret"],
576 schema_version
=content
["schema_version"],
579 # Add Helm/Juju Repo lists
580 repos
= {"helm-chart": [], "juju-bundle": []}
581 for proj
in content
["_admin"]["projects_read"]:
583 for repo
in self
.db
.get_list(
584 "k8srepos", {"_admin.projects_read": proj
}
586 if repo
["_id"] not in repos
[repo
["type"]]:
587 repos
[repo
["type"]].append(repo
["_id"])
589 content
["_admin"][k
.replace("-", "_") + "_repos"] = repos
[k
]
592 def format_on_edit(self
, final_content
, edit_content
):
593 if final_content
.get("schema_version") and edit_content
.get("credentials"):
594 self
.db
.encrypt_decrypt_fields(
595 edit_content
["credentials"],
597 ["password", "secret"],
598 schema_version
=final_content
["schema_version"],
599 salt
=final_content
["_id"],
602 final_content
["credentials"], edit_content
["credentials"]
604 oid
= super().format_on_edit(final_content
, edit_content
)
607 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
608 final_content
= super(CommonVimWimSdn
, self
).check_conflict_on_edit(
609 session
, final_content
, edit_content
, _id
611 final_content
= super().check_conflict_on_edit(
612 session
, final_content
, edit_content
, _id
614 # Update Helm/Juju Repo lists
615 repos
= {"helm-chart": [], "juju-bundle": []}
616 for proj
in session
.get("set_project", []):
618 for repo
in self
.db
.get_list(
619 "k8srepos", {"_admin.projects_read": proj
}
621 if repo
["_id"] not in repos
[repo
["type"]]:
622 repos
[repo
["type"]].append(repo
["_id"])
624 rlist
= k
.replace("-", "_") + "_repos"
625 if rlist
not in final_content
["_admin"]:
626 final_content
["_admin"][rlist
] = []
627 final_content
["_admin"][rlist
] += repos
[k
]
630 def check_conflict_on_del(self
, session
, _id
, db_content
):
632 Check if deletion can be done because of dependencies if it is not force. To override
633 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
634 :param _id: internal _id
635 :param db_content: The database content of this item _id
636 :return: None if ok or raises EngineException with the conflict
640 # check if used by VNF
641 filter_q
= {"kdur.k8s-cluster.id": _id
}
642 if session
["project_id"]:
643 filter_q
["_admin.projects_read.cont"] = session
["project_id"]
644 if self
.db
.get_list("vnfrs", filter_q
):
645 raise EngineException(
646 "There is at least one VNF using this k8scluster",
647 http_code
=HTTPStatus
.CONFLICT
,
649 super().check_conflict_on_del(session
, _id
, db_content
)
652 class VcaTopic(CommonVimWimSdn
):
655 schema_new
= vca_new_schema
656 schema_edit
= vca_edit_schema
658 password_to_encrypt
= None
660 def format_on_new(self
, content
, project_id
=None, make_public
=False):
661 oid
= super().format_on_new(content
, project_id
, make_public
)
662 content
["schema_version"] = schema_version
= "1.11"
663 for key
in ["secret", "cacert"]:
664 content
[key
] = self
.db
.encrypt(
665 content
[key
], schema_version
=schema_version
, salt
=content
["_id"]
669 def format_on_edit(self
, final_content
, edit_content
):
670 oid
= super().format_on_edit(final_content
, edit_content
)
671 schema_version
= final_content
.get("schema_version")
672 for key
in ["secret", "cacert"]:
673 if key
in edit_content
:
674 final_content
[key
] = self
.db
.encrypt(
676 schema_version
=schema_version
,
677 salt
=final_content
["_id"],
681 def check_conflict_on_del(self
, session
, _id
, db_content
):
683 Check if deletion can be done because of dependencies if it is not force. To override
684 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
685 :param _id: internal _id
686 :param db_content: The database content of this item _id
687 :return: None if ok or raises EngineException with the conflict
691 # check if used by VNF
692 filter_q
= {"vca": _id
}
693 if session
["project_id"]:
694 filter_q
["_admin.projects_read.cont"] = session
["project_id"]
695 if self
.db
.get_list("vim_accounts", filter_q
):
696 raise EngineException(
697 "There is at least one VIM account using this vca",
698 http_code
=HTTPStatus
.CONFLICT
,
700 super().check_conflict_on_del(session
, _id
, db_content
)
703 class K8sRepoTopic(CommonVimWimSdn
):
705 topic_msg
= "k8srepo"
706 schema_new
= k8srepo_new_schema
707 schema_edit
= k8srepo_edit_schema
709 password_to_encrypt
= None
710 config_to_encrypt
= {}
712 def format_on_new(self
, content
, project_id
=None, make_public
=False):
713 oid
= super().format_on_new(content
, project_id
, make_public
)
714 # Update Helm/Juju Repo lists
715 repo_list
= content
["type"].replace("-", "_") + "_repos"
716 for proj
in content
["_admin"]["projects_read"]:
721 "_admin.projects_read": proj
,
722 "_admin." + repo_list
+ ".ne": content
["_id"],
725 push
={"_admin." + repo_list
: content
["_id"]},
729 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
730 type = self
.db
.get_one("k8srepos", {"_id": _id
})["type"]
731 oid
= super().delete(session
, _id
, dry_run
, not_send_msg
)
733 # Remove from Helm/Juju Repo lists
734 repo_list
= type.replace("-", "_") + "_repos"
737 {"_admin." + repo_list
: _id
},
739 pull
={"_admin." + repo_list
: _id
},
744 class OsmRepoTopic(BaseTopic
):
746 topic_msg
= "osmrepos"
747 schema_new
= osmrepo_new_schema
748 schema_edit
= osmrepo_edit_schema
750 # TODO: Implement user/password
753 class UserTopicAuth(UserTopic
):
756 schema_new
= user_new_schema
757 schema_edit
= user_edit_schema
759 def __init__(self
, db
, fs
, msg
, auth
):
760 UserTopic
.__init
__(self
, db
, fs
, msg
, auth
)
763 def check_conflict_on_new(self
, session
, indata
):
765 Check that the data to be inserted is valid
767 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
768 :param indata: data to be inserted
769 :return: None or raises EngineException
771 username
= indata
.get("username")
772 if is_valid_uuid(username
):
773 raise EngineException(
774 "username '{}' cannot have a uuid format".format(username
),
775 HTTPStatus
.UNPROCESSABLE_ENTITY
,
778 # Check that username is not used, regardless keystone already checks this
779 if self
.auth
.get_user_list(filter_q
={"name": username
}):
780 raise EngineException(
781 "username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
784 if "projects" in indata
.keys():
785 # convert to new format project_role_mappings
786 role
= self
.auth
.get_role_list({"name": "project_admin"})
788 role
= self
.auth
.get_role_list()
790 raise AuthconnNotFoundException(
791 "Can't find default role for user '{}'".format(username
)
794 if not indata
.get("project_role_mappings"):
795 indata
["project_role_mappings"] = []
796 for project
in indata
["projects"]:
797 pid
= self
.auth
.get_project(project
)["_id"]
798 prm
= {"project": pid
, "role": rid
}
799 if prm
not in indata
["project_role_mappings"]:
800 indata
["project_role_mappings"].append(prm
)
801 # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
802 # HTTPStatus.BAD_REQUEST)
804 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
806 Check that the data to be edited/uploaded is valid
808 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
809 :param final_content: data once modified
810 :param edit_content: incremental data that contains the modifications to apply
811 :param _id: internal _id
812 :return: None or raises EngineException
815 if "username" in edit_content
:
816 username
= edit_content
.get("username")
817 if is_valid_uuid(username
):
818 raise EngineException(
819 "username '{}' cannot have an uuid format".format(username
),
820 HTTPStatus
.UNPROCESSABLE_ENTITY
,
823 # Check that username is not used, regardless keystone already checks this
824 if self
.auth
.get_user_list(filter_q
={"name": username
}):
825 raise EngineException(
826 "username '{}' is already used".format(username
),
830 if final_content
["username"] == "admin":
831 for mapping
in edit_content
.get("remove_project_role_mappings", ()):
832 if mapping
["project"] == "admin" and mapping
.get("role") in (
836 # TODO make this also available for project id and role id
837 raise EngineException(
838 "You cannot remove system_admin role from admin user",
839 http_code
=HTTPStatus
.FORBIDDEN
,
844 def check_conflict_on_del(self
, session
, _id
, db_content
):
846 Check if deletion can be done because of dependencies if it is not force. To override
847 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
848 :param _id: internal _id
849 :param db_content: The database content of this item _id
850 :return: None if ok or raises EngineException with the conflict
852 if db_content
["username"] == session
["username"]:
853 raise EngineException(
854 "You cannot delete your own login user ", http_code
=HTTPStatus
.CONFLICT
856 # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
859 def format_on_show(content
):
861 Modifies the content of the role information to separate the role
862 metadata from the role definition.
864 project_role_mappings
= []
866 if "projects" in content
:
867 for project
in content
["projects"]:
868 for role
in project
["roles"]:
869 project_role_mappings
.append(
871 "project": project
["_id"],
872 "project_name": project
["name"],
874 "role_name": role
["name"],
877 del content
["projects"]
878 content
["project_role_mappings"] = project_role_mappings
882 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
884 Creates a new entry into the authentication backend.
886 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
888 :param rollback: list to append created items at database in case a rollback may to be done
889 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
890 :param indata: data to be inserted
891 :param kwargs: used to override the indata descriptor
892 :param headers: http request headers
893 :return: _id: identity of the inserted data, operation _id (None)
896 content
= BaseTopic
._remove
_envelop
(indata
)
898 # Override descriptor with query string kwargs
899 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
900 content
= self
._validate
_input
_new
(content
, session
["force"])
901 self
.check_conflict_on_new(session
, content
)
902 # self.format_on_new(content, session["project_id"], make_public=session["public"])
904 content
["_admin"] = {"created": now
, "modified": now
}
906 for prm
in content
.get("project_role_mappings", []):
907 proj
= self
.auth
.get_project(prm
["project"], not session
["force"])
908 role
= self
.auth
.get_role(prm
["role"], not session
["force"])
909 pid
= proj
["_id"] if proj
else None
910 rid
= role
["_id"] if role
else None
911 prl
= {"project": pid
, "role": rid
}
914 content
["project_role_mappings"] = prms
915 # _id = self.auth.create_user(content["username"], content["password"])["_id"]
916 _id
= self
.auth
.create_user(content
)["_id"]
918 rollback
.append({"topic": self
.topic
, "_id": _id
})
919 # del content["password"]
920 self
._send
_msg
("created", content
, not_send_msg
=None)
922 except ValidationError
as e
:
923 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
925 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
927 Get complete information on an topic
929 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
930 :param _id: server internal id or username
931 :param filter_q: dict: query parameter
932 :param api_req: True if this call is serving an external API request. False if serving internal request.
933 :return: dictionary, raise exception if not found.
935 # Allow _id to be a name or uuid
936 filter_q
= {"username": _id
}
937 # users = self.auth.get_user_list(filter_q)
938 users
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
942 raise EngineException(
943 "Too many users found for '{}'".format(_id
), HTTPStatus
.CONFLICT
946 raise EngineException(
947 "User '{}' not found".format(_id
), HTTPStatus
.NOT_FOUND
950 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
952 Updates an user entry.
954 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
956 :param indata: data to be inserted
957 :param kwargs: used to override the indata descriptor
959 :return: _id: identity of the inserted data.
961 indata
= self
._remove
_envelop
(indata
)
963 # Override descriptor with query string kwargs
965 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
968 content
= self
.show(session
, _id
)
969 indata
= self
._validate
_input
_edit
(indata
, content
, force
=session
["force"])
970 content
= self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
971 # self.format_on_edit(content, indata)
975 or "username" in indata
976 or indata
.get("remove_project_role_mappings")
977 or indata
.get("add_project_role_mappings")
978 or indata
.get("project_role_mappings")
979 or indata
.get("projects")
980 or indata
.get("add_projects")
983 if indata
.get("project_role_mappings") and (
984 indata
.get("remove_project_role_mappings")
985 or indata
.get("add_project_role_mappings")
987 raise EngineException(
988 "Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
989 "' or 'remove_project_role_mappings'",
990 http_code
=HTTPStatus
.BAD_REQUEST
,
993 if indata
.get("projects") or indata
.get("add_projects"):
994 role
= self
.auth
.get_role_list({"name": "project_admin"})
996 role
= self
.auth
.get_role_list()
998 raise AuthconnNotFoundException(
999 "Can't find a default role for user '{}'".format(
1003 rid
= role
[0]["_id"]
1004 if "add_project_role_mappings" not in indata
:
1005 indata
["add_project_role_mappings"] = []
1006 if "remove_project_role_mappings" not in indata
:
1007 indata
["remove_project_role_mappings"] = []
1008 if isinstance(indata
.get("projects"), dict):
1009 # backward compatible
1010 for k
, v
in indata
["projects"].items():
1011 if k
.startswith("$") and v
is None:
1012 indata
["remove_project_role_mappings"].append(
1015 elif k
.startswith("$+"):
1016 indata
["add_project_role_mappings"].append(
1017 {"project": v
, "role": rid
}
1019 del indata
["projects"]
1020 for proj
in indata
.get("projects", []) + indata
.get("add_projects", []):
1021 indata
["add_project_role_mappings"].append(
1022 {"project": proj
, "role": rid
}
1025 # user = self.show(session, _id) # Already in 'content'
1026 original_mapping
= content
["project_role_mappings"]
1028 mappings_to_add
= []
1029 mappings_to_remove
= []
1032 for to_remove
in indata
.get("remove_project_role_mappings", ()):
1033 for mapping
in original_mapping
:
1034 if to_remove
["project"] in (
1036 mapping
["project_name"],
1038 if not to_remove
.get("role") or to_remove
["role"] in (
1040 mapping
["role_name"],
1042 mappings_to_remove
.append(mapping
)
1045 for to_add
in indata
.get("add_project_role_mappings", ()):
1046 for mapping
in original_mapping
:
1047 if to_add
["project"] in (
1049 mapping
["project_name"],
1050 ) and to_add
["role"] in (
1052 mapping
["role_name"],
1055 if mapping
in mappings_to_remove
: # do not remove
1056 mappings_to_remove
.remove(mapping
)
1057 break # do not add, it is already at user
1059 pid
= self
.auth
.get_project(to_add
["project"])["_id"]
1060 rid
= self
.auth
.get_role(to_add
["role"])["_id"]
1061 mappings_to_add
.append({"project": pid
, "role": rid
})
1064 if indata
.get("project_role_mappings"):
1065 for to_set
in indata
["project_role_mappings"]:
1066 for mapping
in original_mapping
:
1067 if to_set
["project"] in (
1069 mapping
["project_name"],
1070 ) and to_set
["role"] in (
1072 mapping
["role_name"],
1074 if mapping
in mappings_to_remove
: # do not remove
1075 mappings_to_remove
.remove(mapping
)
1076 break # do not add, it is already at user
1078 pid
= self
.auth
.get_project(to_set
["project"])["_id"]
1079 rid
= self
.auth
.get_role(to_set
["role"])["_id"]
1080 mappings_to_add
.append({"project": pid
, "role": rid
})
1081 for mapping
in original_mapping
:
1082 for to_set
in indata
["project_role_mappings"]:
1083 if to_set
["project"] in (
1085 mapping
["project_name"],
1086 ) and to_set
["role"] in (
1088 mapping
["role_name"],
1093 if mapping
not in mappings_to_remove
: # do not remove
1094 mappings_to_remove
.append(mapping
)
1096 self
.auth
.update_user(
1099 "username": indata
.get("username"),
1100 "password": indata
.get("password"),
1101 "add_project_role_mappings": mappings_to_add
,
1102 "remove_project_role_mappings": mappings_to_remove
,
1105 data_to_send
= {"_id": _id
, "changes": indata
}
1106 self
._send
_msg
("edited", data_to_send
, not_send_msg
=None)
1109 except ValidationError
as e
:
1110 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1112 def list(self
, session
, filter_q
=None, api_req
=False):
1114 Get a list of the topic that matches a filter
1115 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1116 :param filter_q: filter of data to be applied
1117 :param api_req: True if this call is serving an external API request. False if serving internal request.
1118 :return: The list, it can be empty if no one match the filter.
1120 user_list
= self
.auth
.get_user_list(filter_q
)
1121 if not session
["allow_show_user_project_role"]:
1122 # Bug 853 - Default filtering
1124 usr
for usr
in user_list
if usr
["username"] == session
["username"]
1128 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1130 Delete item by its internal _id
1132 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1133 :param _id: server internal id
1134 :param force: indicates if deletion must be forced in case of conflict
1135 :param dry_run: make checking but do not delete
1136 :param not_send_msg: To not send message (False) or store content (list) instead
1137 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1139 # Allow _id to be a name or uuid
1140 user
= self
.auth
.get_user(_id
)
1142 self
.check_conflict_on_del(session
, uid
, user
)
1144 v
= self
.auth
.delete_user(uid
)
1145 self
._send
_msg
("deleted", user
, not_send_msg
=not_send_msg
)
1150 class ProjectTopicAuth(ProjectTopic
):
1151 # topic = "projects"
1152 topic_msg
= "project"
1153 schema_new
= project_new_schema
1154 schema_edit
= project_edit_schema
1156 def __init__(self
, db
, fs
, msg
, auth
):
1157 ProjectTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1160 def check_conflict_on_new(self
, session
, indata
):
1162 Check that the data to be inserted is valid
1164 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1165 :param indata: data to be inserted
1166 :return: None or raises EngineException
1168 project_name
= indata
.get("name")
1169 if is_valid_uuid(project_name
):
1170 raise EngineException(
1171 "project name '{}' cannot have an uuid format".format(project_name
),
1172 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1175 project_list
= self
.auth
.get_project_list(filter_q
={"name": project_name
})
1178 raise EngineException(
1179 "project '{}' exists".format(project_name
), HTTPStatus
.CONFLICT
1182 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
1184 Check that the data to be edited/uploaded is valid
1186 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1187 :param final_content: data once modified
1188 :param edit_content: incremental data that contains the modifications to apply
1189 :param _id: internal _id
1190 :return: None or raises EngineException
1193 project_name
= edit_content
.get("name")
1194 if project_name
!= final_content
["name"]: # It is a true renaming
1195 if is_valid_uuid(project_name
):
1196 raise EngineException(
1197 "project name '{}' cannot have an uuid format".format(project_name
),
1198 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1201 if final_content
["name"] == "admin":
1202 raise EngineException(
1203 "You cannot rename project 'admin'", http_code
=HTTPStatus
.CONFLICT
1206 # Check that project name is not used, regardless keystone already checks this
1207 if project_name
and self
.auth
.get_project_list(
1208 filter_q
={"name": project_name
}
1210 raise EngineException(
1211 "project '{}' is already used".format(project_name
),
1212 HTTPStatus
.CONFLICT
,
1214 return final_content
1216 def check_conflict_on_del(self
, session
, _id
, db_content
):
1218 Check if deletion can be done because of dependencies if it is not force. To override
1220 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1221 :param _id: internal _id
1222 :param db_content: The database content of this item _id
1223 :return: None if ok or raises EngineException with the conflict
1226 def check_rw_projects(topic
, title
, id_field
):
1227 for desc
in self
.db
.get_list(topic
):
1230 in desc
["_admin"]["projects_read"]
1231 + desc
["_admin"]["projects_write"]
1233 raise EngineException(
1234 "Project '{}' ({}) is being used by {} '{}'".format(
1235 db_content
["name"], _id
, title
, desc
[id_field
]
1237 HTTPStatus
.CONFLICT
,
1240 if _id
in session
["project_id"]:
1241 raise EngineException(
1242 "You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
1245 if db_content
["name"] == "admin":
1246 raise EngineException(
1247 "You cannot delete project 'admin'", http_code
=HTTPStatus
.CONFLICT
1250 # If any user is using this project, raise CONFLICT exception
1251 if not session
["force"]:
1252 for user
in self
.auth
.get_user_list():
1253 for prm
in user
.get("project_role_mappings"):
1254 if prm
["project"] == _id
:
1255 raise EngineException(
1256 "Project '{}' ({}) is being used by user '{}'".format(
1257 db_content
["name"], _id
, user
["username"]
1259 HTTPStatus
.CONFLICT
,
1262 # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
1263 if not session
["force"]:
1264 check_rw_projects("vnfds", "VNF Descriptor", "id")
1265 check_rw_projects("nsds", "NS Descriptor", "id")
1266 check_rw_projects("nsts", "NS Template", "id")
1267 check_rw_projects("pdus", "PDU Descriptor", "name")
1269 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1271 Creates a new entry into the authentication backend.
1273 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
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)
1283 content
= BaseTopic
._remove
_envelop
(indata
)
1285 # Override descriptor with query string kwargs
1286 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
1287 content
= self
._validate
_input
_new
(content
, session
["force"])
1288 self
.check_conflict_on_new(session
, content
)
1290 content
, project_id
=session
["project_id"], make_public
=session
["public"]
1292 _id
= self
.auth
.create_project(content
)
1293 rollback
.append({"topic": self
.topic
, "_id": _id
})
1294 self
._send
_msg
("created", content
, not_send_msg
=None)
1296 except ValidationError
as e
:
1297 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1299 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
1301 Get complete information on an topic
1303 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1304 :param _id: server internal id
1305 :param filter_q: dict: query parameter
1306 :param api_req: True if this call is serving an external API request. False if serving internal request.
1307 :return: dictionary, raise exception if not found.
1309 # Allow _id to be a name or uuid
1310 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
1311 # projects = self.auth.get_project_list(filter_q=filter_q)
1312 projects
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
1313 if len(projects
) == 1:
1315 elif len(projects
) > 1:
1316 raise EngineException("Too many projects found", HTTPStatus
.CONFLICT
)
1318 raise EngineException("Project not found", HTTPStatus
.NOT_FOUND
)
1320 def list(self
, session
, filter_q
=None, api_req
=False):
1322 Get a list of the topic that matches a filter
1324 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1325 :param filter_q: filter of data to be applied
1326 :return: The list, it can be empty if no one match the filter.
1328 project_list
= self
.auth
.get_project_list(filter_q
)
1329 if not session
["allow_show_user_project_role"]:
1330 # Bug 853 - Default filtering
1331 user
= self
.auth
.get_user(session
["username"])
1332 projects
= [prm
["project"] for prm
in user
["project_role_mappings"]]
1333 project_list
= [proj
for proj
in project_list
if proj
["_id"] in projects
]
1336 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1338 Delete item by its internal _id
1340 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1341 :param _id: server internal id
1342 :param dry_run: make checking but do not delete
1343 :param not_send_msg: To not send message (False) or store content (list) instead
1344 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1346 # Allow _id to be a name or uuid
1347 proj
= self
.auth
.get_project(_id
)
1349 self
.check_conflict_on_del(session
, pid
, proj
)
1351 v
= self
.auth
.delete_project(pid
)
1352 self
._send
_msg
("deleted", proj
, not_send_msg
=None)
1356 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1358 Updates a project entry.
1360 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1362 :param indata: data to be inserted
1363 :param kwargs: used to override the indata descriptor
1365 :return: _id: identity of the inserted data.
1367 indata
= self
._remove
_envelop
(indata
)
1369 # Override descriptor with query string kwargs
1371 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
1374 content
= self
.show(session
, _id
)
1375 indata
= self
._validate
_input
_edit
(indata
, content
, force
=session
["force"])
1376 content
= self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1377 self
.format_on_edit(content
, indata
)
1378 content_original
= copy
.deepcopy(content
)
1379 deep_update_rfc7396(content
, indata
)
1380 self
.auth
.update_project(content
["_id"], content
)
1381 proj_data
= {"_id": _id
, "changes": indata
, "original": content_original
}
1382 self
._send
_msg
("edited", proj_data
, not_send_msg
=None)
1383 except ValidationError
as e
:
1384 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1387 class RoleTopicAuth(BaseTopic
):
1389 topic_msg
= None # "roles"
1390 schema_new
= roles_new_schema
1391 schema_edit
= roles_edit_schema
1392 multiproject
= False
1394 def __init__(self
, db
, fs
, msg
, auth
):
1395 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1397 self
.operations
= auth
.role_permissions
1398 # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
1401 def validate_role_definition(operations
, role_definitions
):
1403 Validates the role definition against the operations defined in
1404 the resources to operations files.
1406 :param operations: operations list
1407 :param role_definitions: role definition to test
1408 :return: None if ok, raises ValidationError exception on error
1410 if not role_definitions
.get("permissions"):
1412 ignore_fields
= ["admin", "default"]
1413 for role_def
in role_definitions
["permissions"].keys():
1414 if role_def
in ignore_fields
:
1416 if role_def
[-1] == ":":
1417 raise ValidationError("Operation cannot end with ':'")
1422 for op
in operations
1423 if op
== role_def
or op
.startswith(role_def
+ ":")
1429 raise ValidationError("Invalid permission '{}'".format(role_def
))
1431 def _validate_input_new(self
, input, force
=False):
1433 Validates input user content for a new entry.
1435 :param input: user input content for the new topic
1436 :param force: may be used for being more tolerant
1437 :return: The same input content, or a changed version of it.
1440 validate_input(input, self
.schema_new
)
1441 self
.validate_role_definition(self
.operations
, input)
1445 def _validate_input_edit(self
, input, content
, force
=False):
1447 Validates input user content for updating an entry.
1449 :param input: user input content for the new topic
1450 :param force: may be used for being more tolerant
1451 :return: The same input content, or a changed version of it.
1453 if self
.schema_edit
:
1454 validate_input(input, self
.schema_edit
)
1455 self
.validate_role_definition(self
.operations
, input)
1459 def check_conflict_on_new(self
, session
, indata
):
1461 Check that the data to be inserted is valid
1463 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1464 :param indata: data to be inserted
1465 :return: None or raises EngineException
1467 # check name is not uuid
1468 role_name
= indata
.get("name")
1469 if is_valid_uuid(role_name
):
1470 raise EngineException(
1471 "role name '{}' cannot have an uuid format".format(role_name
),
1472 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1474 # check name not exists
1475 name
= indata
["name"]
1476 # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
1477 if self
.auth
.get_role_list({"name": name
}):
1478 raise EngineException(
1479 "role name '{}' exists".format(name
), HTTPStatus
.CONFLICT
1482 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
1484 Check that the data to be edited/uploaded is valid
1486 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1487 :param final_content: data once modified
1488 :param edit_content: incremental data that contains the modifications to apply
1489 :param _id: internal _id
1490 :return: None or raises EngineException
1492 if "default" not in final_content
["permissions"]:
1493 final_content
["permissions"]["default"] = False
1494 if "admin" not in final_content
["permissions"]:
1495 final_content
["permissions"]["admin"] = False
1497 # check name is not uuid
1498 role_name
= edit_content
.get("name")
1499 if is_valid_uuid(role_name
):
1500 raise EngineException(
1501 "role name '{}' cannot have an uuid format".format(role_name
),
1502 HTTPStatus
.UNPROCESSABLE_ENTITY
,
1505 # Check renaming of admin roles
1506 role
= self
.auth
.get_role(_id
)
1507 if role
["name"] in ["system_admin", "project_admin"]:
1508 raise EngineException(
1509 "You cannot rename role '{}'".format(role
["name"]),
1510 http_code
=HTTPStatus
.FORBIDDEN
,
1513 # check name not exists
1514 if "name" in edit_content
:
1515 role_name
= edit_content
["name"]
1516 # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
1517 roles
= self
.auth
.get_role_list({"name": role_name
})
1518 if roles
and roles
[0][BaseTopic
.id_field("roles", _id
)] != _id
:
1519 raise EngineException(
1520 "role name '{}' exists".format(role_name
), HTTPStatus
.CONFLICT
1523 return final_content
1525 def check_conflict_on_del(self
, session
, _id
, db_content
):
1527 Check if deletion can be done because of dependencies if it is not force. To override
1529 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1530 :param _id: internal _id
1531 :param db_content: The database content of this item _id
1532 :return: None if ok or raises EngineException with the conflict
1534 role
= self
.auth
.get_role(_id
)
1535 if role
["name"] in ["system_admin", "project_admin"]:
1536 raise EngineException(
1537 "You cannot delete role '{}'".format(role
["name"]),
1538 http_code
=HTTPStatus
.FORBIDDEN
,
1541 # If any user is using this role, raise CONFLICT exception
1542 if not session
["force"]:
1543 for user
in self
.auth
.get_user_list():
1544 for prm
in user
.get("project_role_mappings"):
1545 if prm
["role"] == _id
:
1546 raise EngineException(
1547 "Role '{}' ({}) is being used by user '{}'".format(
1548 role
["name"], _id
, user
["username"]
1550 HTTPStatus
.CONFLICT
,
1554 def format_on_new(content
, project_id
=None, make_public
=False): # TO BE REMOVED ?
1556 Modifies content descriptor to include _admin
1558 :param content: descriptor to be modified
1559 :param project_id: if included, it add project read/write permissions
1560 :param make_public: if included it is generated as public for reading.
1561 :return: None, but content is modified
1564 if "_admin" not in content
:
1565 content
["_admin"] = {}
1566 if not content
["_admin"].get("created"):
1567 content
["_admin"]["created"] = now
1568 content
["_admin"]["modified"] = now
1570 if "permissions" not in content
:
1571 content
["permissions"] = {}
1573 if "default" not in content
["permissions"]:
1574 content
["permissions"]["default"] = False
1575 if "admin" not in content
["permissions"]:
1576 content
["permissions"]["admin"] = False
1579 def format_on_edit(final_content
, edit_content
):
1581 Modifies final_content descriptor to include the modified date.
1583 :param final_content: final descriptor generated
1584 :param edit_content: alterations to be include
1585 :return: None, but final_content is modified
1587 if "_admin" in final_content
:
1588 final_content
["_admin"]["modified"] = time()
1590 if "permissions" not in final_content
:
1591 final_content
["permissions"] = {}
1593 if "default" not in final_content
["permissions"]:
1594 final_content
["permissions"]["default"] = False
1595 if "admin" not in final_content
["permissions"]:
1596 final_content
["permissions"]["admin"] = False
1599 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
1601 Get complete information on an topic
1603 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1604 :param _id: server internal id
1605 :param filter_q: dict: query parameter
1606 :param api_req: True if this call is serving an external API request. False if serving internal request.
1607 :return: dictionary, raise exception if not found.
1609 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1610 # roles = self.auth.get_role_list(filter_q)
1611 roles
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
1613 raise AuthconnNotFoundException(
1614 "Not found any role with filter {}".format(filter_q
)
1616 elif len(roles
) > 1:
1617 raise AuthconnConflictException(
1618 "Found more than one role with filter {}".format(filter_q
)
1622 def list(self
, session
, filter_q
=None, api_req
=False):
1624 Get a list of the topic that matches a filter
1626 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1627 :param filter_q: filter of data to be applied
1628 :return: The list, it can be empty if no one match the filter.
1630 role_list
= self
.auth
.get_role_list(filter_q
)
1631 if not session
["allow_show_user_project_role"]:
1632 # Bug 853 - Default filtering
1633 user
= self
.auth
.get_user(session
["username"])
1634 roles
= [prm
["role"] for prm
in user
["project_role_mappings"]]
1635 role_list
= [role
for role
in role_list
if role
["_id"] in roles
]
1638 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1640 Creates a new entry into database.
1642 :param rollback: list to append created items at database in case a rollback may to be done
1643 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1644 :param indata: data to be inserted
1645 :param kwargs: used to override the indata descriptor
1646 :param headers: http request headers
1647 :return: _id: identity of the inserted data, operation _id (None)
1650 content
= self
._remove
_envelop
(indata
)
1652 # Override descriptor with query string kwargs
1653 self
._update
_input
_with
_kwargs
(content
, kwargs
)
1654 content
= self
._validate
_input
_new
(content
, session
["force"])
1655 self
.check_conflict_on_new(session
, content
)
1657 content
, project_id
=session
["project_id"], make_public
=session
["public"]
1659 # role_name = content["name"]
1660 rid
= self
.auth
.create_role(content
)
1661 content
["_id"] = rid
1662 # _id = self.db.create(self.topic, content)
1663 rollback
.append({"topic": self
.topic
, "_id": rid
})
1664 # self._send_msg("created", content, not_send_msg=not_send_msg)
1666 except ValidationError
as e
:
1667 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1669 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1671 Delete item by its internal _id
1673 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1674 :param _id: server internal id
1675 :param dry_run: make checking but do not delete
1676 :param not_send_msg: To not send message (False) or store content (list) instead
1677 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1679 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1680 roles
= self
.auth
.get_role_list(filter_q
)
1682 raise AuthconnNotFoundException(
1683 "Not found any role with filter {}".format(filter_q
)
1685 elif len(roles
) > 1:
1686 raise AuthconnConflictException(
1687 "Found more than one role with filter {}".format(filter_q
)
1689 rid
= roles
[0]["_id"]
1690 self
.check_conflict_on_del(session
, rid
, None)
1691 # filter_q = {"_id": _id}
1692 # filter_q = {BaseTopic.id_field(self.topic, _id): _id} # To allow role addressing by name
1694 v
= self
.auth
.delete_role(rid
)
1695 # v = self.db.del_one(self.topic, filter_q)
1699 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1701 Updates a role entry.
1703 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1705 :param indata: data to be inserted
1706 :param kwargs: used to override the indata descriptor
1708 :return: _id: identity of the inserted data.
1711 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1714 content
= self
.show(session
, _id
)
1715 indata
= self
._validate
_input
_edit
(indata
, content
, force
=session
["force"])
1716 deep_update_rfc7396(content
, indata
)
1717 content
= self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1718 self
.format_on_edit(content
, indata
)
1719 self
.auth
.update_role(content
)
1720 except ValidationError
as e
:
1721 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)