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 osmrepo_new_schema
, osmrepo_edit_schema
, \
26 validate_input
, ValidationError
, is_valid_uuid
# To check that User/Project Names don't look like UUIDs
27 from osm_nbi
.base_topic
import BaseTopic
, EngineException
28 from osm_nbi
.authconn
import AuthconnNotFoundException
, AuthconnConflictException
29 from osm_common
.dbbase
import deep_update_rfc7396
31 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
34 class UserTopic(BaseTopic
):
37 schema_new
= user_new_schema
38 schema_edit
= user_edit_schema
41 def __init__(self
, db
, fs
, msg
, auth
):
42 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
45 def _get_project_filter(session
):
47 Generates a filter dictionary for querying database users.
48 Current policy is admin can show all, non admin, only its own user.
49 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
52 if session
["admin"]: # allows all
55 return {"username": session
["username"]}
57 def check_conflict_on_new(self
, session
, indata
):
58 # check username not exists
59 if self
.db
.get_one(self
.topic
, {"username": indata
.get("username")}, fail_on_empty
=False, fail_on_more
=False):
60 raise EngineException("username '{}' exists".format(indata
["username"]), HTTPStatus
.CONFLICT
)
62 if not session
["force"]:
63 for p
in indata
.get("projects") or []:
64 # To allow project addressing by Name as well as ID
65 if not self
.db
.get_one("projects", {BaseTopic
.id_field("projects", p
): p
}, fail_on_empty
=False,
67 raise EngineException("project '{}' does not exist".format(p
), HTTPStatus
.CONFLICT
)
69 def check_conflict_on_del(self
, session
, _id
, db_content
):
71 Check if deletion can be done because of dependencies if it is not force. To override
72 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
73 :param _id: internal _id
74 :param db_content: The database content of this item _id
75 :return: None if ok or raises EngineException with the conflict
77 if _id
== session
["username"]:
78 raise EngineException("You cannot delete your own user", http_code
=HTTPStatus
.CONFLICT
)
81 def format_on_new(content
, project_id
=None, make_public
=False):
82 BaseTopic
.format_on_new(content
, make_public
=False)
83 # Removed so that the UUID is kept, to allow User Name modification
84 # content["_id"] = content["username"]
86 content
["_admin"]["salt"] = salt
87 if content
.get("password"):
88 content
["password"] = sha256(content
["password"].encode('utf-8') + salt
.encode('utf-8')).hexdigest()
89 if content
.get("project_role_mappings"):
90 projects
= [mapping
["project"] for mapping
in content
["project_role_mappings"]]
92 if content
.get("projects"):
93 content
["projects"] += projects
95 content
["projects"] = projects
98 def format_on_edit(final_content
, edit_content
):
99 BaseTopic
.format_on_edit(final_content
, edit_content
)
100 if edit_content
.get("password"):
102 final_content
["_admin"]["salt"] = salt
103 final_content
["password"] = sha256(edit_content
["password"].encode('utf-8') +
104 salt
.encode('utf-8')).hexdigest()
107 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
108 if not session
["admin"]:
109 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
110 # Names that look like UUIDs are not allowed
111 name
= (indata
if indata
else kwargs
).get("username")
112 if is_valid_uuid(name
):
113 raise EngineException("Usernames that look like UUIDs are not allowed",
114 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
115 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
117 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
118 if not session
["admin"]:
119 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
120 # Names that look like UUIDs are not allowed
121 name
= indata
["username"] if indata
else kwargs
["username"]
122 if is_valid_uuid(name
):
123 raise EngineException("Usernames that look like UUIDs are not allowed",
124 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
125 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
128 class ProjectTopic(BaseTopic
):
130 topic_msg
= "projects"
131 schema_new
= project_new_schema
132 schema_edit
= project_edit_schema
135 def __init__(self
, db
, fs
, msg
, auth
):
136 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
139 def _get_project_filter(session
):
141 Generates a filter dictionary for querying database users.
142 Current policy is admin can show all, non admin, only its own user.
143 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
146 if session
["admin"]: # allows all
149 return {"_id.cont": session
["project_id"]}
151 def check_conflict_on_new(self
, session
, indata
):
152 if not indata
.get("name"):
153 raise EngineException("missing 'name'")
154 # check name not exists
155 if self
.db
.get_one(self
.topic
, {"name": indata
.get("name")}, fail_on_empty
=False, fail_on_more
=False):
156 raise EngineException("name '{}' exists".format(indata
["name"]), HTTPStatus
.CONFLICT
)
159 def format_on_new(content
, project_id
=None, make_public
=False):
160 BaseTopic
.format_on_new(content
, None)
161 # Removed so that the UUID is kept, to allow Project Name modification
162 # content["_id"] = content["name"]
164 def check_conflict_on_del(self
, session
, _id
, db_content
):
166 Check if deletion can be done because of dependencies if it is not force. To override
167 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
168 :param _id: internal _id
169 :param db_content: The database content of this item _id
170 :return: None if ok or raises EngineException with the conflict
172 if _id
in session
["project_id"]:
173 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
176 _filter
= {"projects": _id
}
177 if self
.db
.get_list("users", _filter
):
178 raise EngineException("There is some USER that contains this project", http_code
=HTTPStatus
.CONFLICT
)
180 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
181 if not session
["admin"]:
182 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
183 # Names that look like UUIDs are not allowed
184 name
= (indata
if indata
else kwargs
).get("name")
185 if is_valid_uuid(name
):
186 raise EngineException("Project names that look like UUIDs are not allowed",
187 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
188 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
190 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
191 if not session
["admin"]:
192 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
193 # Names that look like UUIDs are not allowed
194 name
= indata
["name"] if indata
else kwargs
["name"]
195 if is_valid_uuid(name
):
196 raise EngineException("Project names that look like UUIDs are not allowed",
197 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
198 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
201 class CommonVimWimSdn(BaseTopic
):
202 """Common class for VIM, WIM SDN just to unify methods that are equal to all of them"""
203 config_to_encrypt
= {} # what keys at config must be encrypted because contains passwords
204 password_to_encrypt
= "" # key that contains a password
207 def _create_operation(op_type
, params
=None):
209 Creates a dictionary with the information to an operation, similar to ns-lcm-op
210 :param op_type: can be create, edit, delete
211 :param params: operation input parameters
212 :return: new dictionary with
216 "lcmOperationType": op_type
,
217 "operationState": "PROCESSING",
219 "statusEnteredTime": now
,
220 "detailed-status": "",
221 "operationParams": params
,
224 def check_conflict_on_new(self
, session
, indata
):
226 Check that the data to be inserted is valid. It is checked that name is unique
227 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
228 :param indata: data to be inserted
229 :return: None or raises EngineException
231 self
.check_unique_name(session
, indata
["name"], _id
=None)
233 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
235 Check that the data to be edited/uploaded is valid. It is checked that name is unique
236 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
237 :param final_content: data once modified. This method may change it.
238 :param edit_content: incremental data that contains the modifications to apply
239 :param _id: internal _id
240 :return: None or raises EngineException
242 if not session
["force"] and edit_content
.get("name"):
243 self
.check_unique_name(session
, edit_content
["name"], _id
=_id
)
245 def format_on_edit(self
, final_content
, edit_content
):
247 Modifies final_content inserting admin information upon edition
248 :param final_content: final content to be stored at database
249 :param edit_content: user requested update content
250 :return: operation id
252 super().format_on_edit(final_content
, edit_content
)
255 schema_version
= final_content
.get("schema_version")
257 if edit_content
.get(self
.password_to_encrypt
):
258 final_content
[self
.password_to_encrypt
] = self
.db
.encrypt(edit_content
[self
.password_to_encrypt
],
259 schema_version
=schema_version
,
260 salt
=final_content
["_id"])
261 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
262 if edit_content
.get("config") and config_to_encrypt_keys
:
264 for p
in config_to_encrypt_keys
:
265 if edit_content
["config"].get(p
):
266 final_content
["config"][p
] = self
.db
.encrypt(edit_content
["config"][p
],
267 schema_version
=schema_version
,
268 salt
=final_content
["_id"])
270 # create edit operation
271 final_content
["_admin"]["operations"].append(self
._create
_operation
("edit"))
272 return "{}:{}".format(final_content
["_id"], len(final_content
["_admin"]["operations"]) - 1)
274 def format_on_new(self
, content
, project_id
=None, make_public
=False):
276 Modifies content descriptor to include _admin and insert create operation
277 :param content: descriptor to be modified
278 :param project_id: if included, it add project read/write permissions. Can be None or a list
279 :param make_public: if included it is generated as public for reading.
280 :return: op_id: operation id on asynchronous operation, None otherwise. In addition content is modified
282 super().format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
283 content
["schema_version"] = schema_version
= "1.11"
286 if content
.get(self
.password_to_encrypt
):
287 content
[self
.password_to_encrypt
] = self
.db
.encrypt(content
[self
.password_to_encrypt
],
288 schema_version
=schema_version
,
290 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
291 if content
.get("config") and config_to_encrypt_keys
:
292 for p
in config_to_encrypt_keys
:
293 if content
["config"].get(p
):
294 content
["config"][p
] = self
.db
.encrypt(content
["config"][p
],
295 schema_version
=schema_version
,
298 content
["_admin"]["operationalState"] = "PROCESSING"
301 content
["_admin"]["operations"] = [self
._create
_operation
("create")]
302 content
["_admin"]["current_operation"] = None
304 return "{}:0".format(content
["_id"])
306 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
308 Delete item by its internal _id
309 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
310 :param _id: server internal id
311 :param dry_run: make checking but do not delete
312 :param not_send_msg: To not send message (False) or store content (list) instead
313 :return: operation id if it is ordered to delete. None otherwise
316 filter_q
= self
._get
_project
_filter
(session
)
317 filter_q
["_id"] = _id
318 db_content
= self
.db
.get_one(self
.topic
, filter_q
)
320 self
.check_conflict_on_del(session
, _id
, db_content
)
324 # remove reference from project_read if there are more projects referencing it. If it last one,
325 # do not remove reference, but order via kafka to delete it
326 if session
["project_id"] and session
["project_id"]:
327 other_projects_referencing
= next((p
for p
in db_content
["_admin"]["projects_read"]
328 if p
not in session
["project_id"]), None)
330 # check if there are projects referencing it (apart from ANY, that means, public)....
331 if other_projects_referencing
:
332 # remove references but not delete
333 update_dict_pull
= {"_admin.projects_read.{}".format(p
): None for p
in session
["project_id"]}
334 update_dict_pull
.update({"_admin.projects_write.{}".format(p
): None for p
in session
["project_id"]})
335 self
.db
.set_one(self
.topic
, filter_q
, update_dict
=None, pull
=update_dict_pull
)
338 can_write
= next((p
for p
in db_content
["_admin"]["projects_write"] if p
== "ANY" or
339 p
in session
["project_id"]), None)
341 raise EngineException("You have not write permission to delete it",
342 http_code
=HTTPStatus
.UNAUTHORIZED
)
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
]
475 def check_conflict_on_del(self
, session
, _id
, db_content
):
477 Check if deletion can be done because of dependencies if it is not force. To override
478 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
479 :param _id: internal _id
480 :param db_content: The database content of this item _id
481 :return: None if ok or raises EngineException with the conflict
485 # check if used by VNF
486 filter_q
= {"kdur.k8s-cluster.id": _id
}
487 if session
["project_id"]:
488 filter_q
["_admin.projects_read.cont"] = session
["project_id"]
489 if self
.db
.get_list("vnfrs", filter_q
):
490 raise EngineException("There is at least one VNF using this k8scluster", http_code
=HTTPStatus
.CONFLICT
)
491 super().check_conflict_on_del(session
, _id
, db_content
)
494 class K8sRepoTopic(CommonVimWimSdn
):
496 topic_msg
= "k8srepo"
497 schema_new
= k8srepo_new_schema
498 schema_edit
= k8srepo_edit_schema
500 password_to_encrypt
= None
501 config_to_encrypt
= {}
503 def format_on_new(self
, content
, project_id
=None, make_public
=False):
504 oid
= super().format_on_new(content
, project_id
, make_public
)
505 # Update Helm/Juju Repo lists
506 repo_list
= content
["type"].replace('-', '_')+"_repos"
507 for proj
in content
["_admin"]["projects_read"]:
509 self
.db
.set_list("k8sclusters",
510 {"_admin.projects_read": proj
, "_admin."+repo_list
+".ne": content
["_id"]}, {},
511 push
={"_admin."+repo_list
: content
["_id"]})
514 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
515 type = self
.db
.get_one("k8srepos", {"_id": _id
})["type"]
516 oid
= super().delete(session
, _id
, dry_run
, not_send_msg
)
518 # Remove from Helm/Juju Repo lists
519 repo_list
= type.replace('-', '_') + "_repos"
520 self
.db
.set_list("k8sclusters", {"_admin."+repo_list
: _id
}, {}, pull
={"_admin."+repo_list
: _id
})
524 class OsmRepoTopic(BaseTopic
):
526 topic_msg
= "osmrepos"
527 schema_new
= osmrepo_new_schema
528 schema_edit
= osmrepo_edit_schema
530 # TODO: Implement user/password
533 class UserTopicAuth(UserTopic
):
535 # topic_msg = "users"
536 schema_new
= user_new_schema
537 schema_edit
= user_edit_schema
539 def __init__(self
, db
, fs
, msg
, auth
):
540 UserTopic
.__init
__(self
, db
, fs
, msg
, auth
)
543 def check_conflict_on_new(self
, session
, indata
):
545 Check that the data to be inserted is valid
547 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
548 :param indata: data to be inserted
549 :return: None or raises EngineException
551 username
= indata
.get("username")
552 if is_valid_uuid(username
):
553 raise EngineException("username '{}' cannot have a uuid format".format(username
),
554 HTTPStatus
.UNPROCESSABLE_ENTITY
)
556 # Check that username is not used, regardless keystone already checks this
557 if self
.auth
.get_user_list(filter_q
={"name": username
}):
558 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
560 if "projects" in indata
.keys():
561 # convert to new format project_role_mappings
562 role
= self
.auth
.get_role_list({"name": "project_admin"})
564 role
= self
.auth
.get_role_list()
566 raise AuthconnNotFoundException("Can't find default role for user '{}'".format(username
))
568 if not indata
.get("project_role_mappings"):
569 indata
["project_role_mappings"] = []
570 for project
in indata
["projects"]:
571 pid
= self
.auth
.get_project(project
)["_id"]
572 prm
= {"project": pid
, "role": rid
}
573 if prm
not in indata
["project_role_mappings"]:
574 indata
["project_role_mappings"].append(prm
)
575 # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
576 # HTTPStatus.BAD_REQUEST)
578 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
580 Check that the data to be edited/uploaded is valid
582 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
583 :param final_content: data once modified
584 :param edit_content: incremental data that contains the modifications to apply
585 :param _id: internal _id
586 :return: None or raises EngineException
589 if "username" in edit_content
:
590 username
= edit_content
.get("username")
591 if is_valid_uuid(username
):
592 raise EngineException("username '{}' cannot have an uuid format".format(username
),
593 HTTPStatus
.UNPROCESSABLE_ENTITY
)
595 # Check that username is not used, regardless keystone already checks this
596 if self
.auth
.get_user_list(filter_q
={"name": username
}):
597 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
599 if final_content
["username"] == "admin":
600 for mapping
in edit_content
.get("remove_project_role_mappings", ()):
601 if mapping
["project"] == "admin" and mapping
.get("role") in (None, "system_admin"):
602 # TODO make this also available for project id and role id
603 raise EngineException("You cannot remove system_admin role from admin user",
604 http_code
=HTTPStatus
.FORBIDDEN
)
606 def check_conflict_on_del(self
, session
, _id
, db_content
):
608 Check if deletion can be done because of dependencies if it is not force. To override
609 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
610 :param _id: internal _id
611 :param db_content: The database content of this item _id
612 :return: None if ok or raises EngineException with the conflict
614 if db_content
["username"] == session
["username"]:
615 raise EngineException("You cannot delete your own login user ", http_code
=HTTPStatus
.CONFLICT
)
616 # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
619 def format_on_show(content
):
621 Modifies the content of the role information to separate the role
622 metadata from the role definition.
624 project_role_mappings
= []
626 if "projects" in content
:
627 for project
in content
["projects"]:
628 for role
in project
["roles"]:
629 project_role_mappings
.append({"project": project
["_id"],
630 "project_name": project
["name"],
632 "role_name": role
["name"]})
633 del content
["projects"]
634 content
["project_role_mappings"] = project_role_mappings
638 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
640 Creates a new entry into the authentication backend.
642 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
644 :param rollback: list to append created items at database in case a rollback may to be done
645 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
646 :param indata: data to be inserted
647 :param kwargs: used to override the indata descriptor
648 :param headers: http request headers
649 :return: _id: identity of the inserted data, operation _id (None)
652 content
= BaseTopic
._remove
_envelop
(indata
)
654 # Override descriptor with query string kwargs
655 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
656 content
= self
._validate
_input
_new
(content
, session
["force"])
657 self
.check_conflict_on_new(session
, content
)
658 # self.format_on_new(content, session["project_id"], make_public=session["public"])
660 content
["_admin"] = {"created": now
, "modified": now
}
662 for prm
in content
.get("project_role_mappings", []):
663 proj
= self
.auth
.get_project(prm
["project"], not session
["force"])
664 role
= self
.auth
.get_role(prm
["role"], not session
["force"])
665 pid
= proj
["_id"] if proj
else None
666 rid
= role
["_id"] if role
else None
667 prl
= {"project": pid
, "role": rid
}
670 content
["project_role_mappings"] = prms
671 # _id = self.auth.create_user(content["username"], content["password"])["_id"]
672 _id
= self
.auth
.create_user(content
)["_id"]
674 rollback
.append({"topic": self
.topic
, "_id": _id
})
675 # del content["password"]
676 # self._send_msg("created", content, not_send_msg=not_send_msg)
678 except ValidationError
as e
:
679 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
681 def show(self
, session
, _id
):
683 Get complete information on an topic
685 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
686 :param _id: server internal id or username
687 :return: dictionary, raise exception if not found.
689 # Allow _id to be a name or uuid
690 filter_q
= {"username": _id
}
691 # users = self.auth.get_user_list(filter_q)
692 users
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
696 raise EngineException("Too many users found for '{}'".format(_id
), HTTPStatus
.CONFLICT
)
698 raise EngineException("User '{}' not found".format(_id
), HTTPStatus
.NOT_FOUND
)
700 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
702 Updates an user entry.
704 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
706 :param indata: data to be inserted
707 :param kwargs: used to override the indata descriptor
709 :return: _id: identity of the inserted data.
711 indata
= self
._remove
_envelop
(indata
)
713 # Override descriptor with query string kwargs
715 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
717 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
720 content
= self
.show(session
, _id
)
721 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
722 # self.format_on_edit(content, indata)
724 if not ("password" in indata
or "username" in indata
or indata
.get("remove_project_role_mappings") or
725 indata
.get("add_project_role_mappings") or indata
.get("project_role_mappings") or
726 indata
.get("projects") or indata
.get("add_projects")):
728 if indata
.get("project_role_mappings") \
729 and (indata
.get("remove_project_role_mappings") or indata
.get("add_project_role_mappings")):
730 raise EngineException("Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
731 "' or 'remove_project_role_mappings'", http_code
=HTTPStatus
.BAD_REQUEST
)
733 if indata
.get("projects") or indata
.get("add_projects"):
734 role
= self
.auth
.get_role_list({"name": "project_admin"})
736 role
= self
.auth
.get_role_list()
738 raise AuthconnNotFoundException("Can't find a default role for user '{}'"
739 .format(content
["username"]))
741 if "add_project_role_mappings" not in indata
:
742 indata
["add_project_role_mappings"] = []
743 if "remove_project_role_mappings" not in indata
:
744 indata
["remove_project_role_mappings"] = []
745 if isinstance(indata
.get("projects"), dict):
746 # backward compatible
747 for k
, v
in indata
["projects"].items():
748 if k
.startswith("$") and v
is None:
749 indata
["remove_project_role_mappings"].append({"project": k
[1:]})
750 elif k
.startswith("$+"):
751 indata
["add_project_role_mappings"].append({"project": v
, "role": rid
})
752 del indata
["projects"]
753 for proj
in indata
.get("projects", []) + indata
.get("add_projects", []):
754 indata
["add_project_role_mappings"].append({"project": proj
, "role": rid
})
756 # user = self.show(session, _id) # Already in 'content'
757 original_mapping
= content
["project_role_mappings"]
760 mappings_to_remove
= []
763 for to_remove
in indata
.get("remove_project_role_mappings", ()):
764 for mapping
in original_mapping
:
765 if to_remove
["project"] in (mapping
["project"], mapping
["project_name"]):
766 if not to_remove
.get("role") or to_remove
["role"] in (mapping
["role"], mapping
["role_name"]):
767 mappings_to_remove
.append(mapping
)
770 for to_add
in indata
.get("add_project_role_mappings", ()):
771 for mapping
in original_mapping
:
772 if to_add
["project"] in (mapping
["project"], mapping
["project_name"]) and \
773 to_add
["role"] in (mapping
["role"], mapping
["role_name"]):
775 if mapping
in mappings_to_remove
: # do not remove
776 mappings_to_remove
.remove(mapping
)
777 break # do not add, it is already at user
779 pid
= self
.auth
.get_project(to_add
["project"])["_id"]
780 rid
= self
.auth
.get_role(to_add
["role"])["_id"]
781 mappings_to_add
.append({"project": pid
, "role": rid
})
784 if indata
.get("project_role_mappings"):
785 for to_set
in indata
["project_role_mappings"]:
786 for mapping
in original_mapping
:
787 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
788 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
789 if mapping
in mappings_to_remove
: # do not remove
790 mappings_to_remove
.remove(mapping
)
791 break # do not add, it is already at user
793 pid
= self
.auth
.get_project(to_set
["project"])["_id"]
794 rid
= self
.auth
.get_role(to_set
["role"])["_id"]
795 mappings_to_add
.append({"project": pid
, "role": rid
})
796 for mapping
in original_mapping
:
797 for to_set
in indata
["project_role_mappings"]:
798 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
799 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
803 if mapping
not in mappings_to_remove
: # do not remove
804 mappings_to_remove
.append(mapping
)
806 self
.auth
.update_user({"_id": _id
, "username": indata
.get("username"), "password": indata
.get("password"),
807 "add_project_role_mappings": mappings_to_add
,
808 "remove_project_role_mappings": mappings_to_remove
812 except ValidationError
as e
:
813 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
815 def list(self
, session
, filter_q
=None):
817 Get a list of the topic that matches a filter
818 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
819 :param filter_q: filter of data to be applied
820 :return: The list, it can be empty if no one match the filter.
822 user_list
= self
.auth
.get_user_list(filter_q
)
823 if not session
["allow_show_user_project_role"]:
824 # Bug 853 - Default filtering
825 user_list
= [usr
for usr
in user_list
if usr
["username"] == session
["username"]]
828 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
830 Delete item by its internal _id
832 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
833 :param _id: server internal id
834 :param force: indicates if deletion must be forced in case of conflict
835 :param dry_run: make checking but do not delete
836 :param not_send_msg: To not send message (False) or store content (list) instead
837 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
839 # Allow _id to be a name or uuid
840 user
= self
.auth
.get_user(_id
)
842 self
.check_conflict_on_del(session
, uid
, user
)
844 v
= self
.auth
.delete_user(uid
)
849 class ProjectTopicAuth(ProjectTopic
):
851 # topic_msg = "projects"
852 schema_new
= project_new_schema
853 schema_edit
= project_edit_schema
855 def __init__(self
, db
, fs
, msg
, auth
):
856 ProjectTopic
.__init
__(self
, db
, fs
, msg
, auth
)
859 def check_conflict_on_new(self
, session
, indata
):
861 Check that the data to be inserted is valid
863 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
864 :param indata: data to be inserted
865 :return: None or raises EngineException
867 project_name
= indata
.get("name")
868 if is_valid_uuid(project_name
):
869 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
870 HTTPStatus
.UNPROCESSABLE_ENTITY
)
872 project_list
= self
.auth
.get_project_list(filter_q
={"name": project_name
})
875 raise EngineException("project '{}' exists".format(project_name
), HTTPStatus
.CONFLICT
)
877 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
879 Check that the data to be edited/uploaded is valid
881 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
882 :param final_content: data once modified
883 :param edit_content: incremental data that contains the modifications to apply
884 :param _id: internal _id
885 :return: None or raises EngineException
888 project_name
= edit_content
.get("name")
889 if project_name
!= final_content
["name"]: # It is a true renaming
890 if is_valid_uuid(project_name
):
891 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
892 HTTPStatus
.UNPROCESSABLE_ENTITY
)
894 if final_content
["name"] == "admin":
895 raise EngineException("You cannot rename project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
897 # Check that project name is not used, regardless keystone already checks this
898 if project_name
and self
.auth
.get_project_list(filter_q
={"name": project_name
}):
899 raise EngineException("project '{}' is already used".format(project_name
), HTTPStatus
.CONFLICT
)
901 def check_conflict_on_del(self
, session
, _id
, db_content
):
903 Check if deletion can be done because of dependencies if it is not force. To override
905 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
906 :param _id: internal _id
907 :param db_content: The database content of this item _id
908 :return: None if ok or raises EngineException with the conflict
911 def check_rw_projects(topic
, title
, id_field
):
912 for desc
in self
.db
.get_list(topic
):
913 if _id
in desc
["_admin"]["projects_read"] + desc
["_admin"]["projects_write"]:
914 raise EngineException("Project '{}' ({}) is being used by {} '{}'"
915 .format(db_content
["name"], _id
, title
, desc
[id_field
]), HTTPStatus
.CONFLICT
)
917 if _id
in session
["project_id"]:
918 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
920 if db_content
["name"] == "admin":
921 raise EngineException("You cannot delete project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
923 # If any user is using this project, raise CONFLICT exception
924 if not session
["force"]:
925 for user
in self
.auth
.get_user_list():
926 for prm
in user
.get("project_role_mappings"):
927 if prm
["project"] == _id
:
928 raise EngineException("Project '{}' ({}) is being used by user '{}'"
929 .format(db_content
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
931 # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
932 if not session
["force"]:
933 check_rw_projects("vnfds", "VNF Descriptor", "id")
934 check_rw_projects("nsds", "NS Descriptor", "id")
935 check_rw_projects("nsts", "NS Template", "id")
936 check_rw_projects("pdus", "PDU Descriptor", "name")
938 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
940 Creates a new entry into the authentication backend.
942 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
944 :param rollback: list to append created items at database in case a rollback may to be done
945 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
946 :param indata: data to be inserted
947 :param kwargs: used to override the indata descriptor
948 :param headers: http request headers
949 :return: _id: identity of the inserted data, operation _id (None)
952 content
= BaseTopic
._remove
_envelop
(indata
)
954 # Override descriptor with query string kwargs
955 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
956 content
= self
._validate
_input
_new
(content
, session
["force"])
957 self
.check_conflict_on_new(session
, content
)
958 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
959 _id
= self
.auth
.create_project(content
)
960 rollback
.append({"topic": self
.topic
, "_id": _id
})
961 # self._send_msg("created", content, not_send_msg=not_send_msg)
963 except ValidationError
as e
:
964 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
966 def show(self
, session
, _id
):
968 Get complete information on an topic
970 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
971 :param _id: server internal id
972 :return: dictionary, raise exception if not found.
974 # Allow _id to be a name or uuid
975 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
976 # projects = self.auth.get_project_list(filter_q=filter_q)
977 projects
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
978 if len(projects
) == 1:
980 elif len(projects
) > 1:
981 raise EngineException("Too many projects found", HTTPStatus
.CONFLICT
)
983 raise EngineException("Project not found", HTTPStatus
.NOT_FOUND
)
985 def list(self
, session
, filter_q
=None):
987 Get a list of the topic that matches a filter
989 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
990 :param filter_q: filter of data to be applied
991 :return: The list, it can be empty if no one match the filter.
993 project_list
= self
.auth
.get_project_list(filter_q
)
994 if not session
["allow_show_user_project_role"]:
995 # Bug 853 - Default filtering
996 user
= self
.auth
.get_user(session
["username"])
997 projects
= [prm
["project"] for prm
in user
["project_role_mappings"]]
998 project_list
= [proj
for proj
in project_list
if proj
["_id"] in projects
]
1001 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1003 Delete item by its internal _id
1005 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1006 :param _id: server internal id
1007 :param dry_run: make checking but do not delete
1008 :param not_send_msg: To not send message (False) or store content (list) instead
1009 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1011 # Allow _id to be a name or uuid
1012 proj
= self
.auth
.get_project(_id
)
1014 self
.check_conflict_on_del(session
, pid
, proj
)
1016 v
= self
.auth
.delete_project(pid
)
1020 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1022 Updates a project entry.
1024 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1026 :param indata: data to be inserted
1027 :param kwargs: used to override the indata descriptor
1029 :return: _id: identity of the inserted data.
1031 indata
= self
._remove
_envelop
(indata
)
1033 # Override descriptor with query string kwargs
1035 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
1037 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
1040 content
= self
.show(session
, _id
)
1041 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1042 self
.format_on_edit(content
, indata
)
1044 deep_update_rfc7396(content
, indata
)
1045 self
.auth
.update_project(content
["_id"], content
)
1046 except ValidationError
as e
:
1047 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1050 class RoleTopicAuth(BaseTopic
):
1052 topic_msg
= None # "roles"
1053 schema_new
= roles_new_schema
1054 schema_edit
= roles_edit_schema
1055 multiproject
= False
1057 def __init__(self
, db
, fs
, msg
, auth
):
1058 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1060 self
.operations
= auth
.role_permissions
1061 # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
1064 def validate_role_definition(operations
, role_definitions
):
1066 Validates the role definition against the operations defined in
1067 the resources to operations files.
1069 :param operations: operations list
1070 :param role_definitions: role definition to test
1071 :return: None if ok, raises ValidationError exception on error
1073 if not role_definitions
.get("permissions"):
1075 ignore_fields
= ["admin", "default"]
1076 for role_def
in role_definitions
["permissions"].keys():
1077 if role_def
in ignore_fields
:
1079 if role_def
[-1] == ":":
1080 raise ValidationError("Operation cannot end with ':'")
1082 role_def_matches
= [op
for op
in operations
if op
.startswith(role_def
)]
1084 if len(role_def_matches
) == 0:
1085 raise ValidationError("Invalid permission '{}'".format(role_def
))
1087 def _validate_input_new(self
, input, force
=False):
1089 Validates input user content for a new entry.
1091 :param input: user input content for the new topic
1092 :param force: may be used for being more tolerant
1093 :return: The same input content, or a changed version of it.
1096 validate_input(input, self
.schema_new
)
1097 self
.validate_role_definition(self
.operations
, input)
1101 def _validate_input_edit(self
, input, force
=False):
1103 Validates input user content for updating an entry.
1105 :param input: user input content for the new topic
1106 :param force: may be used for being more tolerant
1107 :return: The same input content, or a changed version of it.
1109 if self
.schema_edit
:
1110 validate_input(input, self
.schema_edit
)
1111 self
.validate_role_definition(self
.operations
, input)
1115 def check_conflict_on_new(self
, session
, indata
):
1117 Check that the data to be inserted is valid
1119 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1120 :param indata: data to be inserted
1121 :return: None or raises EngineException
1123 # check name is not uuid
1124 role_name
= indata
.get("name")
1125 if is_valid_uuid(role_name
):
1126 raise EngineException("role name '{}' cannot have an uuid format".format(role_name
),
1127 HTTPStatus
.UNPROCESSABLE_ENTITY
)
1128 # check name not exists
1129 name
= indata
["name"]
1130 # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
1131 if self
.auth
.get_role_list({"name": name
}):
1132 raise EngineException("role name '{}' exists".format(name
), HTTPStatus
.CONFLICT
)
1134 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
1136 Check that the data to be edited/uploaded is valid
1138 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1139 :param final_content: data once modified
1140 :param edit_content: incremental data that contains the modifications to apply
1141 :param _id: internal _id
1142 :return: None or raises EngineException
1144 if "default" not in final_content
["permissions"]:
1145 final_content
["permissions"]["default"] = False
1146 if "admin" not in final_content
["permissions"]:
1147 final_content
["permissions"]["admin"] = False
1149 # check name is not uuid
1150 role_name
= edit_content
.get("name")
1151 if is_valid_uuid(role_name
):
1152 raise EngineException("role name '{}' cannot have an uuid format".format(role_name
),
1153 HTTPStatus
.UNPROCESSABLE_ENTITY
)
1155 # Check renaming of admin roles
1156 role
= self
.auth
.get_role(_id
)
1157 if role
["name"] in ["system_admin", "project_admin"]:
1158 raise EngineException("You cannot rename role '{}'".format(role
["name"]), http_code
=HTTPStatus
.FORBIDDEN
)
1160 # check name not exists
1161 if "name" in edit_content
:
1162 role_name
= edit_content
["name"]
1163 # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
1164 roles
= self
.auth
.get_role_list({"name": role_name
})
1165 if roles
and roles
[0][BaseTopic
.id_field("roles", _id
)] != _id
:
1166 raise EngineException("role name '{}' exists".format(role_name
), HTTPStatus
.CONFLICT
)
1168 def check_conflict_on_del(self
, session
, _id
, db_content
):
1170 Check if deletion can be done because of dependencies if it is not force. To override
1172 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1173 :param _id: internal _id
1174 :param db_content: The database content of this item _id
1175 :return: None if ok or raises EngineException with the conflict
1177 role
= self
.auth
.get_role(_id
)
1178 if role
["name"] in ["system_admin", "project_admin"]:
1179 raise EngineException("You cannot delete role '{}'".format(role
["name"]), http_code
=HTTPStatus
.FORBIDDEN
)
1181 # If any user is using this role, raise CONFLICT exception
1182 if not session
["force"]:
1183 for user
in self
.auth
.get_user_list():
1184 for prm
in user
.get("project_role_mappings"):
1185 if prm
["role"] == _id
:
1186 raise EngineException("Role '{}' ({}) is being used by user '{}'"
1187 .format(role
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
1190 def format_on_new(content
, project_id
=None, make_public
=False): # TO BE REMOVED ?
1192 Modifies content descriptor to include _admin
1194 :param content: descriptor to be modified
1195 :param project_id: if included, it add project read/write permissions
1196 :param make_public: if included it is generated as public for reading.
1197 :return: None, but content is modified
1200 if "_admin" not in content
:
1201 content
["_admin"] = {}
1202 if not content
["_admin"].get("created"):
1203 content
["_admin"]["created"] = now
1204 content
["_admin"]["modified"] = now
1206 if "permissions" not in content
:
1207 content
["permissions"] = {}
1209 if "default" not in content
["permissions"]:
1210 content
["permissions"]["default"] = False
1211 if "admin" not in content
["permissions"]:
1212 content
["permissions"]["admin"] = False
1215 def format_on_edit(final_content
, edit_content
):
1217 Modifies final_content descriptor to include the modified date.
1219 :param final_content: final descriptor generated
1220 :param edit_content: alterations to be include
1221 :return: None, but final_content is modified
1223 if "_admin" in final_content
:
1224 final_content
["_admin"]["modified"] = time()
1226 if "permissions" not in final_content
:
1227 final_content
["permissions"] = {}
1229 if "default" not in final_content
["permissions"]:
1230 final_content
["permissions"]["default"] = False
1231 if "admin" not in final_content
["permissions"]:
1232 final_content
["permissions"]["admin"] = False
1235 def show(self
, session
, _id
):
1237 Get complete information on an topic
1239 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1240 :param _id: server internal id
1241 :return: dictionary, raise exception if not found.
1243 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1244 # roles = self.auth.get_role_list(filter_q)
1245 roles
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
1247 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1248 elif len(roles
) > 1:
1249 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1252 def list(self
, session
, filter_q
=None):
1254 Get a list of the topic that matches a filter
1256 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1257 :param filter_q: filter of data to be applied
1258 :return: The list, it can be empty if no one match the filter.
1260 role_list
= self
.auth
.get_role_list(filter_q
)
1261 if not session
["allow_show_user_project_role"]:
1262 # Bug 853 - Default filtering
1263 user
= self
.auth
.get_user(session
["username"])
1264 roles
= [prm
["role"] for prm
in user
["project_role_mappings"]]
1265 role_list
= [role
for role
in role_list
if role
["_id"] in roles
]
1268 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1270 Creates a new entry into database.
1272 :param rollback: list to append created items at database in case a rollback may to be done
1273 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1274 :param indata: data to be inserted
1275 :param kwargs: used to override the indata descriptor
1276 :param headers: http request headers
1277 :return: _id: identity of the inserted data, operation _id (None)
1280 content
= self
._remove
_envelop
(indata
)
1282 # Override descriptor with query string kwargs
1283 self
._update
_input
_with
_kwargs
(content
, kwargs
)
1284 content
= self
._validate
_input
_new
(content
, session
["force"])
1285 self
.check_conflict_on_new(session
, content
)
1286 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
1287 # role_name = content["name"]
1288 rid
= self
.auth
.create_role(content
)
1289 content
["_id"] = rid
1290 # _id = self.db.create(self.topic, content)
1291 rollback
.append({"topic": self
.topic
, "_id": rid
})
1292 # self._send_msg("created", content, not_send_msg=not_send_msg)
1294 except ValidationError
as e
:
1295 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1297 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1299 Delete item by its internal _id
1301 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1302 :param _id: server internal id
1303 :param dry_run: make checking but do not delete
1304 :param not_send_msg: To not send message (False) or store content (list) instead
1305 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1307 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1308 roles
= self
.auth
.get_role_list(filter_q
)
1310 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1311 elif len(roles
) > 1:
1312 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1313 rid
= roles
[0]["_id"]
1314 self
.check_conflict_on_del(session
, rid
, None)
1315 # filter_q = {"_id": _id}
1316 # filter_q = {BaseTopic.id_field(self.topic, _id): _id} # To allow role addressing by name
1318 v
= self
.auth
.delete_role(rid
)
1319 # v = self.db.del_one(self.topic, filter_q)
1323 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1325 Updates a role entry.
1327 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1329 :param indata: data to be inserted
1330 :param kwargs: used to override the indata descriptor
1332 :return: _id: identity of the inserted data.
1335 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1337 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
1339 content
= self
.show(session
, _id
)
1340 deep_update_rfc7396(content
, indata
)
1341 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1342 self
.format_on_edit(content
, indata
)
1343 self
.auth
.update_role(content
)
1344 except ValidationError
as e
:
1345 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)