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 user_new_schema
, user_edit_schema
, project_new_schema
, project_edit_schema
, \
22 vim_account_new_schema
, vim_account_edit_schema
, sdn_new_schema
, sdn_edit_schema
, \
23 wim_account_new_schema
, wim_account_edit_schema
, roles_new_schema
, roles_edit_schema
, \
24 k8scluster_new_schema
, k8scluster_edit_schema
, k8srepo_new_schema
, k8srepo_edit_schema
, \
25 validate_input
, ValidationError
, is_valid_uuid
# To check that User/Project Names don't look like UUIDs
26 from osm_nbi
.base_topic
import BaseTopic
, EngineException
27 from osm_nbi
.authconn
import AuthconnNotFoundException
, AuthconnConflictException
28 from osm_common
.dbbase
import deep_update_rfc7396
30 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
33 class UserTopic(BaseTopic
):
36 schema_new
= user_new_schema
37 schema_edit
= user_edit_schema
40 def __init__(self
, db
, fs
, msg
, auth
):
41 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
44 def _get_project_filter(session
):
46 Generates a filter dictionary for querying database users.
47 Current policy is admin can show all, non admin, only its own user.
48 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
51 if session
["admin"]: # allows all
54 return {"username": session
["username"]}
56 def check_conflict_on_new(self
, session
, indata
):
57 # check username not exists
58 if self
.db
.get_one(self
.topic
, {"username": indata
.get("username")}, fail_on_empty
=False, fail_on_more
=False):
59 raise EngineException("username '{}' exists".format(indata
["username"]), HTTPStatus
.CONFLICT
)
61 if not session
["force"]:
62 for p
in indata
.get("projects") or []:
63 # To allow project addressing by Name as well as ID
64 if not self
.db
.get_one("projects", {BaseTopic
.id_field("projects", p
): p
}, fail_on_empty
=False,
66 raise EngineException("project '{}' does not exist".format(p
), HTTPStatus
.CONFLICT
)
68 def check_conflict_on_del(self
, session
, _id
, db_content
):
70 Check if deletion can be done because of dependencies if it is not force. To override
71 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
72 :param _id: internal _id
73 :param db_content: The database content of this item _id
74 :return: None if ok or raises EngineException with the conflict
76 if _id
== session
["username"]:
77 raise EngineException("You cannot delete your own user", http_code
=HTTPStatus
.CONFLICT
)
80 def format_on_new(content
, project_id
=None, make_public
=False):
81 BaseTopic
.format_on_new(content
, make_public
=False)
82 # Removed so that the UUID is kept, to allow User Name modification
83 # content["_id"] = content["username"]
85 content
["_admin"]["salt"] = salt
86 if content
.get("password"):
87 content
["password"] = sha256(content
["password"].encode('utf-8') + salt
.encode('utf-8')).hexdigest()
88 if content
.get("project_role_mappings"):
89 projects
= [mapping
["project"] for mapping
in content
["project_role_mappings"]]
91 if content
.get("projects"):
92 content
["projects"] += projects
94 content
["projects"] = projects
97 def format_on_edit(final_content
, edit_content
):
98 BaseTopic
.format_on_edit(final_content
, edit_content
)
99 if edit_content
.get("password"):
101 final_content
["_admin"]["salt"] = salt
102 final_content
["password"] = sha256(edit_content
["password"].encode('utf-8') +
103 salt
.encode('utf-8')).hexdigest()
106 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
107 if not session
["admin"]:
108 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
109 # Names that look like UUIDs are not allowed
110 name
= (indata
if indata
else kwargs
).get("username")
111 if is_valid_uuid(name
):
112 raise EngineException("Usernames that look like UUIDs are not allowed",
113 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
114 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
116 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
117 if not session
["admin"]:
118 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
119 # Names that look like UUIDs are not allowed
120 name
= indata
["username"] if indata
else kwargs
["username"]
121 if is_valid_uuid(name
):
122 raise EngineException("Usernames that look like UUIDs are not allowed",
123 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
124 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
127 class ProjectTopic(BaseTopic
):
129 topic_msg
= "projects"
130 schema_new
= project_new_schema
131 schema_edit
= project_edit_schema
134 def __init__(self
, db
, fs
, msg
, auth
):
135 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
138 def _get_project_filter(session
):
140 Generates a filter dictionary for querying database users.
141 Current policy is admin can show all, non admin, only its own user.
142 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
145 if session
["admin"]: # allows all
148 return {"_id.cont": session
["project_id"]}
150 def check_conflict_on_new(self
, session
, indata
):
151 if not indata
.get("name"):
152 raise EngineException("missing 'name'")
153 # check name not exists
154 if self
.db
.get_one(self
.topic
, {"name": indata
.get("name")}, fail_on_empty
=False, fail_on_more
=False):
155 raise EngineException("name '{}' exists".format(indata
["name"]), HTTPStatus
.CONFLICT
)
158 def format_on_new(content
, project_id
=None, make_public
=False):
159 BaseTopic
.format_on_new(content
, None)
160 # Removed so that the UUID is kept, to allow Project Name modification
161 # content["_id"] = content["name"]
163 def check_conflict_on_del(self
, session
, _id
, db_content
):
165 Check if deletion can be done because of dependencies if it is not force. To override
166 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
167 :param _id: internal _id
168 :param db_content: The database content of this item _id
169 :return: None if ok or raises EngineException with the conflict
171 if _id
in session
["project_id"]:
172 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
175 _filter
= {"projects": _id
}
176 if self
.db
.get_list("users", _filter
):
177 raise EngineException("There is some USER that contains this project", http_code
=HTTPStatus
.CONFLICT
)
179 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
180 if not session
["admin"]:
181 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
182 # Names that look like UUIDs are not allowed
183 name
= (indata
if indata
else kwargs
).get("name")
184 if is_valid_uuid(name
):
185 raise EngineException("Project names that look like UUIDs are not allowed",
186 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
187 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
189 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
190 if not session
["admin"]:
191 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
192 # Names that look like UUIDs are not allowed
193 name
= indata
["name"] if indata
else kwargs
["name"]
194 if is_valid_uuid(name
):
195 raise EngineException("Project names that look like UUIDs are not allowed",
196 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
197 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
200 class CommonVimWimSdn(BaseTopic
):
201 """Common class for VIM, WIM SDN just to unify methods that are equal to all of them"""
202 config_to_encrypt
= {} # what keys at config must be encrypted because contains passwords
203 password_to_encrypt
= "" # key that contains a password
206 def _create_operation(op_type
, params
=None):
208 Creates a dictionary with the information to an operation, similar to ns-lcm-op
209 :param op_type: can be create, edit, delete
210 :param params: operation input parameters
211 :return: new dictionary with
215 "lcmOperationType": op_type
,
216 "operationState": "PROCESSING",
218 "statusEnteredTime": now
,
219 "detailed-status": "",
220 "operationParams": params
,
223 def check_conflict_on_new(self
, session
, indata
):
225 Check that the data to be inserted is valid. It is checked that name is unique
226 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
227 :param indata: data to be inserted
228 :return: None or raises EngineException
230 self
.check_unique_name(session
, indata
["name"], _id
=None)
232 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
234 Check that the data to be edited/uploaded is valid. It is checked that name is unique
235 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
236 :param final_content: data once modified. This method may change it.
237 :param edit_content: incremental data that contains the modifications to apply
238 :param _id: internal _id
239 :return: None or raises EngineException
241 if not session
["force"] and edit_content
.get("name"):
242 self
.check_unique_name(session
, edit_content
["name"], _id
=_id
)
244 def format_on_edit(self
, final_content
, edit_content
):
246 Modifies final_content inserting admin information upon edition
247 :param final_content: final content to be stored at database
248 :param edit_content: user requested update content
249 :return: operation id
251 super().format_on_edit(final_content
, edit_content
)
254 schema_version
= final_content
.get("schema_version")
256 if edit_content
.get(self
.password_to_encrypt
):
257 final_content
[self
.password_to_encrypt
] = self
.db
.encrypt(edit_content
[self
.password_to_encrypt
],
258 schema_version
=schema_version
,
259 salt
=final_content
["_id"])
260 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
261 if edit_content
.get("config") and config_to_encrypt_keys
:
263 for p
in config_to_encrypt_keys
:
264 if edit_content
["config"].get(p
):
265 final_content
["config"][p
] = self
.db
.encrypt(edit_content
["config"][p
],
266 schema_version
=schema_version
,
267 salt
=final_content
["_id"])
269 # create edit operation
270 final_content
["_admin"]["operations"].append(self
._create
_operation
("edit"))
271 return "{}:{}".format(final_content
["_id"], len(final_content
["_admin"]["operations"]) - 1)
273 def format_on_new(self
, content
, project_id
=None, make_public
=False):
275 Modifies content descriptor to include _admin and insert create operation
276 :param content: descriptor to be modified
277 :param project_id: if included, it add project read/write permissions. Can be None or a list
278 :param make_public: if included it is generated as public for reading.
279 :return: op_id: operation id on asynchronous operation, None otherwise. In addition content is modified
281 super().format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
282 content
["schema_version"] = schema_version
= "1.11"
285 if content
.get(self
.password_to_encrypt
):
286 content
[self
.password_to_encrypt
] = self
.db
.encrypt(content
[self
.password_to_encrypt
],
287 schema_version
=schema_version
,
289 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
290 if content
.get("config") and config_to_encrypt_keys
:
291 for p
in config_to_encrypt_keys
:
292 if content
["config"].get(p
):
293 content
["config"][p
] = self
.db
.encrypt(content
["config"][p
],
294 schema_version
=schema_version
,
297 content
["_admin"]["operationalState"] = "PROCESSING"
300 content
["_admin"]["operations"] = [self
._create
_operation
("create")]
301 content
["_admin"]["current_operation"] = None
303 return "{}:0".format(content
["_id"])
305 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
307 Delete item by its internal _id
308 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
309 :param _id: server internal id
310 :param dry_run: make checking but do not delete
311 :param not_send_msg: To not send message (False) or store content (list) instead
312 :return: operation id if it is ordered to delete. None otherwise
315 filter_q
= self
._get
_project
_filter
(session
)
316 filter_q
["_id"] = _id
317 db_content
= self
.db
.get_one(self
.topic
, filter_q
)
319 self
.check_conflict_on_del(session
, _id
, db_content
)
323 # remove reference from project_read. If not last delete
324 if session
["project_id"]:
325 for project_id
in session
["project_id"]:
326 if project_id
in db_content
["_admin"]["projects_read"]:
327 db_content
["_admin"]["projects_read"].remove(project_id
)
328 if project_id
in db_content
["_admin"]["projects_write"]:
329 db_content
["_admin"]["projects_write"].remove(project_id
)
331 db_content
["_admin"]["projects_read"].clear()
332 db_content
["_admin"]["projects_write"].clear()
334 update_dict
= {"_admin.projects_read": db_content
["_admin"]["projects_read"],
335 "_admin.projects_write": db_content
["_admin"]["projects_write"]
338 # check if there are projects referencing it (apart from ANY that means public)....
339 if db_content
["_admin"]["projects_read"] and (len(db_content
["_admin"]["projects_read"]) > 1 or
340 db_content
["_admin"]["projects_read"][0] != "ANY"):
341 self
.db
.set_one(self
.topic
, filter_q
, update_dict
=update_dict
) # remove references but not delete
346 self
.db
.del_one(self
.topic
, {"_id": _id
})
348 self
._send
_msg
("deleted", {"_id": _id
, "op_id": op_id
}, not_send_msg
=not_send_msg
)
350 update_dict
["_admin.to_delete"] = True
351 self
.db
.set_one(self
.topic
, {"_id": _id
},
352 update_dict
=update_dict
,
353 push
={"_admin.operations": self
._create
_operation
("delete")}
355 # the number of operations is the operation_id. db_content does not contains the new operation inserted,
356 # so the -1 is not needed
357 op_id
= "{}:{}".format(db_content
["_id"], len(db_content
["_admin"]["operations"]))
358 self
._send
_msg
("delete", {"_id": _id
, "op_id": op_id
}, not_send_msg
=not_send_msg
)
362 class VimAccountTopic(CommonVimWimSdn
):
363 topic
= "vim_accounts"
364 topic_msg
= "vim_account"
365 schema_new
= vim_account_new_schema
366 schema_edit
= vim_account_edit_schema
368 password_to_encrypt
= "vim_password"
369 config_to_encrypt
= {"1.1": ("admin_password", "nsx_password", "vcenter_password"),
370 "default": ("admin_password", "nsx_password", "vcenter_password", "vrops_password")}
372 def check_conflict_on_del(self
, session
, _id
, db_content
):
374 Check if deletion can be done because of dependencies if it is not force. To override
375 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
376 :param _id: internal _id
377 :param db_content: The database content of this item _id
378 :return: None if ok or raises EngineException with the conflict
382 # check if used by VNF
383 if self
.db
.get_list("vnfrs", {"vim-account-id": _id
}):
384 raise EngineException("There is at least one VNF using this VIM account", http_code
=HTTPStatus
.CONFLICT
)
385 super().check_conflict_on_del(session
, _id
, db_content
)
388 class WimAccountTopic(CommonVimWimSdn
):
389 topic
= "wim_accounts"
390 topic_msg
= "wim_account"
391 schema_new
= wim_account_new_schema
392 schema_edit
= wim_account_edit_schema
394 password_to_encrypt
= "wim_password"
395 config_to_encrypt
= {}
398 class SdnTopic(CommonVimWimSdn
):
401 schema_new
= sdn_new_schema
402 schema_edit
= sdn_edit_schema
404 password_to_encrypt
= "password"
405 config_to_encrypt
= {}
407 def _obtain_url(self
, input, create
):
408 if input.get("ip") or input.get("port"):
409 if not input.get("ip") or not input.get("port") or input.get('url'):
410 raise ValidationError("You must provide both 'ip' and 'port' (deprecated); or just 'url' (prefered)")
411 input['url'] = "http://{}:{}/".format(input["ip"], input["port"])
414 elif create
and not input.get('url'):
415 raise ValidationError("You must provide 'url'")
418 def _validate_input_new(self
, input, force
=False):
419 input = super()._validate
_input
_new
(input, force
)
420 return self
._obtain
_url
(input, True)
422 def _validate_input_edit(self
, input, force
=False):
423 input = super()._validate
_input
_edit
(input, force
)
424 return self
._obtain
_url
(input, False)
427 class K8sClusterTopic(CommonVimWimSdn
):
428 topic
= "k8sclusters"
429 topic_msg
= "k8scluster"
430 schema_new
= k8scluster_new_schema
431 schema_edit
= k8scluster_edit_schema
433 password_to_encrypt
= None
434 config_to_encrypt
= {}
436 def format_on_new(self
, content
, project_id
=None, make_public
=False):
437 oid
= super().format_on_new(content
, project_id
, make_public
)
438 self
.db
.encrypt_decrypt_fields(content
["credentials"], 'encrypt', ['password', 'secret'],
439 schema_version
=content
["schema_version"], salt
=content
["_id"])
440 # Add Helm/Juju Repo lists
441 repos
= {"helm-chart": [], "juju-bundle": []}
442 for proj
in content
["_admin"]["projects_read"]:
444 for repo
in self
.db
.get_list("k8srepos", {"_admin.projects_read": proj
}):
445 if repo
["_id"] not in repos
[repo
["type"]]:
446 repos
[repo
["type"]].append(repo
["_id"])
448 content
["_admin"][k
.replace('-', '_')+"_repos"] = repos
[k
]
451 def format_on_edit(self
, final_content
, edit_content
):
452 if final_content
.get("schema_version") and edit_content
.get("credentials"):
453 self
.db
.encrypt_decrypt_fields(edit_content
["credentials"], 'encrypt', ['password', 'secret'],
454 schema_version
=final_content
["schema_version"], salt
=final_content
["_id"])
455 deep_update_rfc7396(final_content
["credentials"], edit_content
["credentials"])
456 oid
= super().format_on_edit(final_content
, edit_content
)
459 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
460 super(CommonVimWimSdn
, self
).check_conflict_on_edit(session
, final_content
, edit_content
, _id
)
461 super().check_conflict_on_edit(session
, final_content
, edit_content
, _id
)
462 # Update Helm/Juju Repo lists
463 repos
= {"helm-chart": [], "juju-bundle": []}
464 for proj
in session
.get("set_project", []):
466 for repo
in self
.db
.get_list("k8srepos", {"_admin.projects_read": proj
}):
467 if repo
["_id"] not in repos
[repo
["type"]]:
468 repos
[repo
["type"]].append(repo
["_id"])
470 rlist
= k
.replace('-', '_') + "_repos"
471 if rlist
not in final_content
["_admin"]:
472 final_content
["_admin"][rlist
] = []
473 final_content
["_admin"][rlist
] += repos
[k
]
476 class K8sRepoTopic(CommonVimWimSdn
):
478 topic_msg
= "k8srepo"
479 schema_new
= k8srepo_new_schema
480 schema_edit
= k8srepo_edit_schema
482 password_to_encrypt
= None
483 config_to_encrypt
= {}
485 def format_on_new(self
, content
, project_id
=None, make_public
=False):
486 oid
= super().format_on_new(content
, project_id
, make_public
)
487 # Update Helm/Juju Repo lists
488 repo_list
= content
["type"].replace('-', '_')+"_repos"
489 for proj
in content
["_admin"]["projects_read"]:
491 self
.db
.set_list("k8sclusters",
492 {"_admin.projects_read": proj
, "_admin."+repo_list
+".ne": content
["_id"]}, {},
493 push
={"_admin."+repo_list
: content
["_id"]})
496 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
497 type = self
.db
.get_one("k8srepos", {"_id": _id
})["type"]
498 oid
= super().delete(session
, _id
, dry_run
, not_send_msg
)
500 # Remove from Helm/Juju Repo lists
501 repo_list
= type.replace('-', '_') + "_repos"
502 self
.db
.set_list("k8sclusters", {"_admin."+repo_list
: _id
}, {}, pull
={"_admin."+repo_list
: _id
})
506 class UserTopicAuth(UserTopic
):
508 # topic_msg = "users"
509 schema_new
= user_new_schema
510 schema_edit
= user_edit_schema
512 def __init__(self
, db
, fs
, msg
, auth
):
513 UserTopic
.__init
__(self
, db
, fs
, msg
, auth
)
516 def check_conflict_on_new(self
, session
, indata
):
518 Check that the data to be inserted is valid
520 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
521 :param indata: data to be inserted
522 :return: None or raises EngineException
524 username
= indata
.get("username")
525 if is_valid_uuid(username
):
526 raise EngineException("username '{}' cannot have a uuid format".format(username
),
527 HTTPStatus
.UNPROCESSABLE_ENTITY
)
529 # Check that username is not used, regardless keystone already checks this
530 if self
.auth
.get_user_list(filter_q
={"name": username
}):
531 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
533 if "projects" in indata
.keys():
534 # convert to new format project_role_mappings
535 role
= self
.auth
.get_role_list({"name": "project_admin"})
537 role
= self
.auth
.get_role_list()
539 raise AuthconnNotFoundException("Can't find default role for user '{}'".format(username
))
541 if not indata
.get("project_role_mappings"):
542 indata
["project_role_mappings"] = []
543 for project
in indata
["projects"]:
544 pid
= self
.auth
.get_project(project
)["_id"]
545 prm
= {"project": pid
, "role": rid
}
546 if prm
not in indata
["project_role_mappings"]:
547 indata
["project_role_mappings"].append(prm
)
548 # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
549 # HTTPStatus.BAD_REQUEST)
551 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
553 Check that the data to be edited/uploaded is valid
555 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
556 :param final_content: data once modified
557 :param edit_content: incremental data that contains the modifications to apply
558 :param _id: internal _id
559 :return: None or raises EngineException
562 if "username" in edit_content
:
563 username
= edit_content
.get("username")
564 if is_valid_uuid(username
):
565 raise EngineException("username '{}' cannot have an uuid format".format(username
),
566 HTTPStatus
.UNPROCESSABLE_ENTITY
)
568 # Check that username is not used, regardless keystone already checks this
569 if self
.auth
.get_user_list(filter_q
={"name": username
}):
570 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
572 if final_content
["username"] == "admin":
573 for mapping
in edit_content
.get("remove_project_role_mappings", ()):
574 if mapping
["project"] == "admin" and mapping
.get("role") in (None, "system_admin"):
575 # TODO make this also available for project id and role id
576 raise EngineException("You cannot remove system_admin role from admin user",
577 http_code
=HTTPStatus
.FORBIDDEN
)
579 def check_conflict_on_del(self
, session
, _id
, db_content
):
581 Check if deletion can be done because of dependencies if it is not force. To override
582 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
583 :param _id: internal _id
584 :param db_content: The database content of this item _id
585 :return: None if ok or raises EngineException with the conflict
587 if db_content
["username"] == session
["username"]:
588 raise EngineException("You cannot delete your own login user ", http_code
=HTTPStatus
.CONFLICT
)
589 # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
592 def format_on_show(content
):
594 Modifies the content of the role information to separate the role
595 metadata from the role definition.
597 project_role_mappings
= []
599 if "projects" in content
:
600 for project
in content
["projects"]:
601 for role
in project
["roles"]:
602 project_role_mappings
.append({"project": project
["_id"],
603 "project_name": project
["name"],
605 "role_name": role
["name"]})
606 del content
["projects"]
607 content
["project_role_mappings"] = project_role_mappings
611 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
613 Creates a new entry into the authentication backend.
615 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
617 :param rollback: list to append created items at database in case a rollback may to be done
618 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
619 :param indata: data to be inserted
620 :param kwargs: used to override the indata descriptor
621 :param headers: http request headers
622 :return: _id: identity of the inserted data, operation _id (None)
625 content
= BaseTopic
._remove
_envelop
(indata
)
627 # Override descriptor with query string kwargs
628 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
629 content
= self
._validate
_input
_new
(content
, session
["force"])
630 self
.check_conflict_on_new(session
, content
)
631 # self.format_on_new(content, session["project_id"], make_public=session["public"])
633 content
["_admin"] = {"created": now
, "modified": now
}
635 for prm
in content
.get("project_role_mappings", []):
636 proj
= self
.auth
.get_project(prm
["project"], not session
["force"])
637 role
= self
.auth
.get_role(prm
["role"], not session
["force"])
638 pid
= proj
["_id"] if proj
else None
639 rid
= role
["_id"] if role
else None
640 prl
= {"project": pid
, "role": rid
}
643 content
["project_role_mappings"] = prms
644 # _id = self.auth.create_user(content["username"], content["password"])["_id"]
645 _id
= self
.auth
.create_user(content
)["_id"]
647 rollback
.append({"topic": self
.topic
, "_id": _id
})
648 # del content["password"]
649 # self._send_msg("created", content, not_send_msg=not_send_msg)
651 except ValidationError
as e
:
652 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
654 def show(self
, session
, _id
):
656 Get complete information on an topic
658 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
659 :param _id: server internal id
660 :return: dictionary, raise exception if not found.
662 # Allow _id to be a name or uuid
663 filter_q
= {"username": _id
}
664 # users = self.auth.get_user_list(filter_q)
665 users
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
669 raise EngineException("Too many users found", HTTPStatus
.CONFLICT
)
671 raise EngineException("User not found", HTTPStatus
.NOT_FOUND
)
673 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
675 Updates an user entry.
677 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
679 :param indata: data to be inserted
680 :param kwargs: used to override the indata descriptor
682 :return: _id: identity of the inserted data.
684 indata
= self
._remove
_envelop
(indata
)
686 # Override descriptor with query string kwargs
688 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
690 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
693 content
= self
.show(session
, _id
)
694 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
695 # self.format_on_edit(content, indata)
697 if not ("password" in indata
or "username" in indata
or indata
.get("remove_project_role_mappings") or
698 indata
.get("add_project_role_mappings") or indata
.get("project_role_mappings") or
699 indata
.get("projects") or indata
.get("add_projects")):
701 if indata
.get("project_role_mappings") \
702 and (indata
.get("remove_project_role_mappings") or indata
.get("add_project_role_mappings")):
703 raise EngineException("Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
704 "' or 'remove_project_role_mappings'", http_code
=HTTPStatus
.BAD_REQUEST
)
706 if indata
.get("projects") or indata
.get("add_projects"):
707 role
= self
.auth
.get_role_list({"name": "project_admin"})
709 role
= self
.auth
.get_role_list()
711 raise AuthconnNotFoundException("Can't find a default role for user '{}'"
712 .format(content
["username"]))
714 if "add_project_role_mappings" not in indata
:
715 indata
["add_project_role_mappings"] = []
716 if "remove_project_role_mappings" not in indata
:
717 indata
["remove_project_role_mappings"] = []
718 if isinstance(indata
.get("projects"), dict):
719 # backward compatible
720 for k
, v
in indata
["projects"].items():
721 if k
.startswith("$") and v
is None:
722 indata
["remove_project_role_mappings"].append({"project": k
[1:]})
723 elif k
.startswith("$+"):
724 indata
["add_project_role_mappings"].append({"project": v
, "role": rid
})
725 del indata
["projects"]
726 for proj
in indata
.get("projects", []) + indata
.get("add_projects", []):
727 indata
["add_project_role_mappings"].append({"project": proj
, "role": rid
})
729 # user = self.show(session, _id) # Already in 'content'
730 original_mapping
= content
["project_role_mappings"]
733 mappings_to_remove
= []
736 for to_remove
in indata
.get("remove_project_role_mappings", ()):
737 for mapping
in original_mapping
:
738 if to_remove
["project"] in (mapping
["project"], mapping
["project_name"]):
739 if not to_remove
.get("role") or to_remove
["role"] in (mapping
["role"], mapping
["role_name"]):
740 mappings_to_remove
.append(mapping
)
743 for to_add
in indata
.get("add_project_role_mappings", ()):
744 for mapping
in original_mapping
:
745 if to_add
["project"] in (mapping
["project"], mapping
["project_name"]) and \
746 to_add
["role"] in (mapping
["role"], mapping
["role_name"]):
748 if mapping
in mappings_to_remove
: # do not remove
749 mappings_to_remove
.remove(mapping
)
750 break # do not add, it is already at user
752 pid
= self
.auth
.get_project(to_add
["project"])["_id"]
753 rid
= self
.auth
.get_role(to_add
["role"])["_id"]
754 mappings_to_add
.append({"project": pid
, "role": rid
})
757 if indata
.get("project_role_mappings"):
758 for to_set
in indata
["project_role_mappings"]:
759 for mapping
in original_mapping
:
760 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
761 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
762 if mapping
in mappings_to_remove
: # do not remove
763 mappings_to_remove
.remove(mapping
)
764 break # do not add, it is already at user
766 pid
= self
.auth
.get_project(to_set
["project"])["_id"]
767 rid
= self
.auth
.get_role(to_set
["role"])["_id"]
768 mappings_to_add
.append({"project": pid
, "role": rid
})
769 for mapping
in original_mapping
:
770 for to_set
in indata
["project_role_mappings"]:
771 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
772 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
776 if mapping
not in mappings_to_remove
: # do not remove
777 mappings_to_remove
.append(mapping
)
779 self
.auth
.update_user({"_id": _id
, "username": indata
.get("username"), "password": indata
.get("password"),
780 "add_project_role_mappings": mappings_to_add
,
781 "remove_project_role_mappings": mappings_to_remove
785 except ValidationError
as e
:
786 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
788 def list(self
, session
, filter_q
=None):
790 Get a list of the topic that matches a filter
791 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
792 :param filter_q: filter of data to be applied
793 :return: The list, it can be empty if no one match the filter.
795 user_list
= self
.auth
.get_user_list(filter_q
)
796 if not session
["allow_show_user_project_role"]:
797 # Bug 853 - Default filtering
798 user_list
= [usr
for usr
in user_list
if usr
["username"] == session
["username"]]
801 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
803 Delete item by its internal _id
805 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
806 :param _id: server internal id
807 :param force: indicates if deletion must be forced in case of conflict
808 :param dry_run: make checking but do not delete
809 :param not_send_msg: To not send message (False) or store content (list) instead
810 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
812 # Allow _id to be a name or uuid
813 user
= self
.auth
.get_user(_id
)
815 self
.check_conflict_on_del(session
, uid
, user
)
817 v
= self
.auth
.delete_user(uid
)
822 class ProjectTopicAuth(ProjectTopic
):
824 # topic_msg = "projects"
825 schema_new
= project_new_schema
826 schema_edit
= project_edit_schema
828 def __init__(self
, db
, fs
, msg
, auth
):
829 ProjectTopic
.__init
__(self
, db
, fs
, msg
, auth
)
832 def check_conflict_on_new(self
, session
, indata
):
834 Check that the data to be inserted is valid
836 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
837 :param indata: data to be inserted
838 :return: None or raises EngineException
840 project_name
= indata
.get("name")
841 if is_valid_uuid(project_name
):
842 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
843 HTTPStatus
.UNPROCESSABLE_ENTITY
)
845 project_list
= self
.auth
.get_project_list(filter_q
={"name": project_name
})
848 raise EngineException("project '{}' exists".format(project_name
), HTTPStatus
.CONFLICT
)
850 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
852 Check that the data to be edited/uploaded is valid
854 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
855 :param final_content: data once modified
856 :param edit_content: incremental data that contains the modifications to apply
857 :param _id: internal _id
858 :return: None or raises EngineException
861 project_name
= edit_content
.get("name")
862 if project_name
!= final_content
["name"]: # It is a true renaming
863 if is_valid_uuid(project_name
):
864 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
865 HTTPStatus
.UNPROCESSABLE_ENTITY
)
867 if final_content
["name"] == "admin":
868 raise EngineException("You cannot rename project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
870 # Check that project name is not used, regardless keystone already checks this
871 if project_name
and self
.auth
.get_project_list(filter_q
={"name": project_name
}):
872 raise EngineException("project '{}' is already used".format(project_name
), HTTPStatus
.CONFLICT
)
874 def check_conflict_on_del(self
, session
, _id
, db_content
):
876 Check if deletion can be done because of dependencies if it is not force. To override
878 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
879 :param _id: internal _id
880 :param db_content: The database content of this item _id
881 :return: None if ok or raises EngineException with the conflict
884 def check_rw_projects(topic
, title
, id_field
):
885 for desc
in self
.db
.get_list(topic
):
886 if _id
in desc
["_admin"]["projects_read"] + desc
["_admin"]["projects_write"]:
887 raise EngineException("Project '{}' ({}) is being used by {} '{}'"
888 .format(db_content
["name"], _id
, title
, desc
[id_field
]), HTTPStatus
.CONFLICT
)
890 if _id
in session
["project_id"]:
891 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
893 if db_content
["name"] == "admin":
894 raise EngineException("You cannot delete project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
896 # If any user is using this project, raise CONFLICT exception
897 if not session
["force"]:
898 for user
in self
.auth
.get_user_list():
899 for prm
in user
.get("project_role_mappings"):
900 if prm
["project"] == _id
:
901 raise EngineException("Project '{}' ({}) is being used by user '{}'"
902 .format(db_content
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
904 # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
905 if not session
["force"]:
906 check_rw_projects("vnfds", "VNF Descriptor", "id")
907 check_rw_projects("nsds", "NS Descriptor", "id")
908 check_rw_projects("nsts", "NS Template", "id")
909 check_rw_projects("pdus", "PDU Descriptor", "name")
911 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
913 Creates a new entry into the authentication backend.
915 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
917 :param rollback: list to append created items at database in case a rollback may to be done
918 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
919 :param indata: data to be inserted
920 :param kwargs: used to override the indata descriptor
921 :param headers: http request headers
922 :return: _id: identity of the inserted data, operation _id (None)
925 content
= BaseTopic
._remove
_envelop
(indata
)
927 # Override descriptor with query string kwargs
928 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
929 content
= self
._validate
_input
_new
(content
, session
["force"])
930 self
.check_conflict_on_new(session
, content
)
931 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
932 _id
= self
.auth
.create_project(content
)
933 rollback
.append({"topic": self
.topic
, "_id": _id
})
934 # self._send_msg("created", content, not_send_msg=not_send_msg)
936 except ValidationError
as e
:
937 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
939 def show(self
, session
, _id
):
941 Get complete information on an topic
943 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
944 :param _id: server internal id
945 :return: dictionary, raise exception if not found.
947 # Allow _id to be a name or uuid
948 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
949 # projects = self.auth.get_project_list(filter_q=filter_q)
950 projects
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
951 if len(projects
) == 1:
953 elif len(projects
) > 1:
954 raise EngineException("Too many projects found", HTTPStatus
.CONFLICT
)
956 raise EngineException("Project not found", HTTPStatus
.NOT_FOUND
)
958 def list(self
, session
, filter_q
=None):
960 Get a list of the topic that matches a filter
962 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
963 :param filter_q: filter of data to be applied
964 :return: The list, it can be empty if no one match the filter.
966 project_list
= self
.auth
.get_project_list(filter_q
)
967 if not session
["allow_show_user_project_role"]:
968 # Bug 853 - Default filtering
969 user
= self
.auth
.get_user(session
["username"])
970 projects
= [prm
["project"] for prm
in user
["project_role_mappings"]]
971 project_list
= [proj
for proj
in project_list
if proj
["_id"] in projects
]
974 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
976 Delete item by its internal _id
978 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
979 :param _id: server internal id
980 :param dry_run: make checking but do not delete
981 :param not_send_msg: To not send message (False) or store content (list) instead
982 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
984 # Allow _id to be a name or uuid
985 proj
= self
.auth
.get_project(_id
)
987 self
.check_conflict_on_del(session
, pid
, proj
)
989 v
= self
.auth
.delete_project(pid
)
993 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
995 Updates a project entry.
997 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
999 :param indata: data to be inserted
1000 :param kwargs: used to override the indata descriptor
1002 :return: _id: identity of the inserted data.
1004 indata
= self
._remove
_envelop
(indata
)
1006 # Override descriptor with query string kwargs
1008 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
1010 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
1013 content
= self
.show(session
, _id
)
1014 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1015 self
.format_on_edit(content
, indata
)
1017 deep_update_rfc7396(content
, indata
)
1018 self
.auth
.update_project(content
["_id"], content
)
1019 except ValidationError
as e
:
1020 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1023 class RoleTopicAuth(BaseTopic
):
1025 topic_msg
= None # "roles"
1026 schema_new
= roles_new_schema
1027 schema_edit
= roles_edit_schema
1028 multiproject
= False
1030 def __init__(self
, db
, fs
, msg
, auth
):
1031 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1033 self
.operations
= auth
.role_permissions
1034 # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
1037 def validate_role_definition(operations
, role_definitions
):
1039 Validates the role definition against the operations defined in
1040 the resources to operations files.
1042 :param operations: operations list
1043 :param role_definitions: role definition to test
1044 :return: None if ok, raises ValidationError exception on error
1046 if not role_definitions
.get("permissions"):
1048 ignore_fields
= ["admin", "default"]
1049 for role_def
in role_definitions
["permissions"].keys():
1050 if role_def
in ignore_fields
:
1052 if role_def
[-1] == ":":
1053 raise ValidationError("Operation cannot end with ':'")
1055 role_def_matches
= [op
for op
in operations
if op
.startswith(role_def
)]
1057 if len(role_def_matches
) == 0:
1058 raise ValidationError("Invalid permission '{}'".format(role_def
))
1060 def _validate_input_new(self
, input, force
=False):
1062 Validates input user content for a new entry.
1064 :param input: user input content for the new topic
1065 :param force: may be used for being more tolerant
1066 :return: The same input content, or a changed version of it.
1069 validate_input(input, self
.schema_new
)
1070 self
.validate_role_definition(self
.operations
, input)
1074 def _validate_input_edit(self
, input, force
=False):
1076 Validates input user content for updating an entry.
1078 :param input: user input content for the new topic
1079 :param force: may be used for being more tolerant
1080 :return: The same input content, or a changed version of it.
1082 if self
.schema_edit
:
1083 validate_input(input, self
.schema_edit
)
1084 self
.validate_role_definition(self
.operations
, input)
1088 def check_conflict_on_new(self
, session
, indata
):
1090 Check that the data to be inserted is valid
1092 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1093 :param indata: data to be inserted
1094 :return: None or raises EngineException
1096 # check name is not uuid
1097 role_name
= indata
.get("name")
1098 if is_valid_uuid(role_name
):
1099 raise EngineException("role name '{}' cannot have an uuid format".format(role_name
),
1100 HTTPStatus
.UNPROCESSABLE_ENTITY
)
1101 # check name not exists
1102 name
= indata
["name"]
1103 # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
1104 if self
.auth
.get_role_list({"name": name
}):
1105 raise EngineException("role name '{}' exists".format(name
), HTTPStatus
.CONFLICT
)
1107 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
1109 Check that the data to be edited/uploaded is valid
1111 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1112 :param final_content: data once modified
1113 :param edit_content: incremental data that contains the modifications to apply
1114 :param _id: internal _id
1115 :return: None or raises EngineException
1117 if "default" not in final_content
["permissions"]:
1118 final_content
["permissions"]["default"] = False
1119 if "admin" not in final_content
["permissions"]:
1120 final_content
["permissions"]["admin"] = False
1122 # check name is not uuid
1123 role_name
= edit_content
.get("name")
1124 if is_valid_uuid(role_name
):
1125 raise EngineException("role name '{}' cannot have an uuid format".format(role_name
),
1126 HTTPStatus
.UNPROCESSABLE_ENTITY
)
1128 # Check renaming of admin roles
1129 role
= self
.auth
.get_role(_id
)
1130 if role
["name"] in ["system_admin", "project_admin"]:
1131 raise EngineException("You cannot rename role '{}'".format(role
["name"]), http_code
=HTTPStatus
.FORBIDDEN
)
1133 # check name not exists
1134 if "name" in edit_content
:
1135 role_name
= edit_content
["name"]
1136 # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
1137 roles
= self
.auth
.get_role_list({"name": role_name
})
1138 if roles
and roles
[0][BaseTopic
.id_field("roles", _id
)] != _id
:
1139 raise EngineException("role name '{}' exists".format(role_name
), HTTPStatus
.CONFLICT
)
1141 def check_conflict_on_del(self
, session
, _id
, db_content
):
1143 Check if deletion can be done because of dependencies if it is not force. To override
1145 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1146 :param _id: internal _id
1147 :param db_content: The database content of this item _id
1148 :return: None if ok or raises EngineException with the conflict
1150 role
= self
.auth
.get_role(_id
)
1151 if role
["name"] in ["system_admin", "project_admin"]:
1152 raise EngineException("You cannot delete role '{}'".format(role
["name"]), http_code
=HTTPStatus
.FORBIDDEN
)
1154 # If any user is using this role, raise CONFLICT exception
1155 if not session
["force"]:
1156 for user
in self
.auth
.get_user_list():
1157 for prm
in user
.get("project_role_mappings"):
1158 if prm
["role"] == _id
:
1159 raise EngineException("Role '{}' ({}) is being used by user '{}'"
1160 .format(role
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
1163 def format_on_new(content
, project_id
=None, make_public
=False): # TO BE REMOVED ?
1165 Modifies content descriptor to include _admin
1167 :param content: descriptor to be modified
1168 :param project_id: if included, it add project read/write permissions
1169 :param make_public: if included it is generated as public for reading.
1170 :return: None, but content is modified
1173 if "_admin" not in content
:
1174 content
["_admin"] = {}
1175 if not content
["_admin"].get("created"):
1176 content
["_admin"]["created"] = now
1177 content
["_admin"]["modified"] = now
1179 if "permissions" not in content
:
1180 content
["permissions"] = {}
1182 if "default" not in content
["permissions"]:
1183 content
["permissions"]["default"] = False
1184 if "admin" not in content
["permissions"]:
1185 content
["permissions"]["admin"] = False
1188 def format_on_edit(final_content
, edit_content
):
1190 Modifies final_content descriptor to include the modified date.
1192 :param final_content: final descriptor generated
1193 :param edit_content: alterations to be include
1194 :return: None, but final_content is modified
1196 if "_admin" in final_content
:
1197 final_content
["_admin"]["modified"] = time()
1199 if "permissions" not in final_content
:
1200 final_content
["permissions"] = {}
1202 if "default" not in final_content
["permissions"]:
1203 final_content
["permissions"]["default"] = False
1204 if "admin" not in final_content
["permissions"]:
1205 final_content
["permissions"]["admin"] = False
1208 def show(self
, session
, _id
):
1210 Get complete information on an topic
1212 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1213 :param _id: server internal id
1214 :return: dictionary, raise exception if not found.
1216 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1217 # roles = self.auth.get_role_list(filter_q)
1218 roles
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
1220 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1221 elif len(roles
) > 1:
1222 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1225 def list(self
, session
, filter_q
=None):
1227 Get a list of the topic that matches a filter
1229 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1230 :param filter_q: filter of data to be applied
1231 :return: The list, it can be empty if no one match the filter.
1233 role_list
= self
.auth
.get_role_list(filter_q
)
1234 if not session
["allow_show_user_project_role"]:
1235 # Bug 853 - Default filtering
1236 user
= self
.auth
.get_user(session
["username"])
1237 roles
= [prm
["role"] for prm
in user
["project_role_mappings"]]
1238 role_list
= [role
for role
in role_list
if role
["_id"] in roles
]
1241 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1243 Creates a new entry into database.
1245 :param rollback: list to append created items at database in case a rollback may to be done
1246 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1247 :param indata: data to be inserted
1248 :param kwargs: used to override the indata descriptor
1249 :param headers: http request headers
1250 :return: _id: identity of the inserted data, operation _id (None)
1253 content
= self
._remove
_envelop
(indata
)
1255 # Override descriptor with query string kwargs
1256 self
._update
_input
_with
_kwargs
(content
, kwargs
)
1257 content
= self
._validate
_input
_new
(content
, session
["force"])
1258 self
.check_conflict_on_new(session
, content
)
1259 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
1260 # role_name = content["name"]
1261 rid
= self
.auth
.create_role(content
)
1262 content
["_id"] = rid
1263 # _id = self.db.create(self.topic, content)
1264 rollback
.append({"topic": self
.topic
, "_id": rid
})
1265 # self._send_msg("created", content, not_send_msg=not_send_msg)
1267 except ValidationError
as e
:
1268 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1270 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1272 Delete item by its internal _id
1274 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1275 :param _id: server internal id
1276 :param dry_run: make checking but do not delete
1277 :param not_send_msg: To not send message (False) or store content (list) instead
1278 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1280 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1281 roles
= self
.auth
.get_role_list(filter_q
)
1283 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1284 elif len(roles
) > 1:
1285 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1286 rid
= roles
[0]["_id"]
1287 self
.check_conflict_on_del(session
, rid
, None)
1288 # filter_q = {"_id": _id}
1289 # filter_q = {BaseTopic.id_field(self.topic, _id): _id} # To allow role addressing by name
1291 v
= self
.auth
.delete_role(rid
)
1292 # v = self.db.del_one(self.topic, filter_q)
1296 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1298 Updates a role entry.
1300 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1302 :param indata: data to be inserted
1303 :param kwargs: used to override the indata descriptor
1305 :return: _id: identity of the inserted data.
1308 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1310 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
1312 content
= self
.show(session
, _id
)
1313 deep_update_rfc7396(content
, indata
)
1314 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1315 self
.format_on_edit(content
, indata
)
1316 self
.auth
.update_role(content
)
1317 except ValidationError
as e
:
1318 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)