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 validate_input
, ValidationError
, is_valid_uuid
# To check that User/Project Names don't look like UUIDs
25 from osm_nbi
.base_topic
import BaseTopic
, EngineException
26 from osm_nbi
.authconn
import AuthconnNotFoundException
, AuthconnConflictException
27 from osm_common
.dbbase
import deep_update_rfc7396
29 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
32 class UserTopic(BaseTopic
):
35 schema_new
= user_new_schema
36 schema_edit
= user_edit_schema
39 def __init__(self
, db
, fs
, msg
):
40 BaseTopic
.__init
__(self
, db
, fs
, msg
)
43 def _get_project_filter(session
):
45 Generates a filter dictionary for querying database users.
46 Current policy is admin can show all, non admin, only its own user.
47 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
50 if session
["admin"]: # allows all
53 return {"username": session
["username"]}
55 def check_conflict_on_new(self
, session
, indata
):
56 # check username not exists
57 if self
.db
.get_one(self
.topic
, {"username": indata
.get("username")}, fail_on_empty
=False, fail_on_more
=False):
58 raise EngineException("username '{}' exists".format(indata
["username"]), HTTPStatus
.CONFLICT
)
60 if not session
["force"]:
61 for p
in indata
.get("projects") or []:
62 # To allow project addressing by Name as well as ID
63 if not self
.db
.get_one("projects", {BaseTopic
.id_field("projects", p
): p
}, fail_on_empty
=False,
65 raise EngineException("project '{}' does not exist".format(p
), HTTPStatus
.CONFLICT
)
67 def check_conflict_on_del(self
, session
, _id
, db_content
):
69 Check if deletion can be done because of dependencies if it is not force. To override
70 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
71 :param _id: internal _id
72 :param db_content: The database content of this item _id
73 :return: None if ok or raises EngineException with the conflict
75 if _id
== session
["username"]:
76 raise EngineException("You cannot delete your own user", http_code
=HTTPStatus
.CONFLICT
)
79 def format_on_new(content
, project_id
=None, make_public
=False):
80 BaseTopic
.format_on_new(content
, make_public
=False)
81 # Removed so that the UUID is kept, to allow User Name modification
82 # content["_id"] = content["username"]
84 content
["_admin"]["salt"] = salt
85 if content
.get("password"):
86 content
["password"] = sha256(content
["password"].encode('utf-8') + salt
.encode('utf-8')).hexdigest()
87 if content
.get("project_role_mappings"):
88 projects
= [mapping
["project"] for mapping
in content
["project_role_mappings"]]
90 if content
.get("projects"):
91 content
["projects"] += projects
93 content
["projects"] = projects
96 def format_on_edit(final_content
, edit_content
):
97 BaseTopic
.format_on_edit(final_content
, edit_content
)
98 if edit_content
.get("password"):
100 final_content
["_admin"]["salt"] = salt
101 final_content
["password"] = sha256(edit_content
["password"].encode('utf-8') +
102 salt
.encode('utf-8')).hexdigest()
105 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
106 if not session
["admin"]:
107 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
108 # Names that look like UUIDs are not allowed
109 name
= (indata
if indata
else kwargs
).get("username")
110 if is_valid_uuid(name
):
111 raise EngineException("Usernames that look like UUIDs are not allowed",
112 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
113 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
115 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
116 if not session
["admin"]:
117 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
118 # Names that look like UUIDs are not allowed
119 name
= indata
["username"] if indata
else kwargs
["username"]
120 if is_valid_uuid(name
):
121 raise EngineException("Usernames that look like UUIDs are not allowed",
122 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
123 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
126 class ProjectTopic(BaseTopic
):
128 topic_msg
= "projects"
129 schema_new
= project_new_schema
130 schema_edit
= project_edit_schema
133 def __init__(self
, db
, fs
, msg
):
134 BaseTopic
.__init
__(self
, db
, fs
, msg
)
137 def _get_project_filter(session
):
139 Generates a filter dictionary for querying database users.
140 Current policy is admin can show all, non admin, only its own user.
141 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
144 if session
["admin"]: # allows all
147 return {"_id.cont": session
["project_id"]}
149 def check_conflict_on_new(self
, session
, indata
):
150 if not indata
.get("name"):
151 raise EngineException("missing 'name'")
152 # check name not exists
153 if self
.db
.get_one(self
.topic
, {"name": indata
.get("name")}, fail_on_empty
=False, fail_on_more
=False):
154 raise EngineException("name '{}' exists".format(indata
["name"]), HTTPStatus
.CONFLICT
)
157 def format_on_new(content
, project_id
=None, make_public
=False):
158 BaseTopic
.format_on_new(content
, None)
159 # Removed so that the UUID is kept, to allow Project Name modification
160 # content["_id"] = content["name"]
162 def check_conflict_on_del(self
, session
, _id
, db_content
):
164 Check if deletion can be done because of dependencies if it is not force. To override
165 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
166 :param _id: internal _id
167 :param db_content: The database content of this item _id
168 :return: None if ok or raises EngineException with the conflict
170 if _id
in session
["project_id"]:
171 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
174 _filter
= {"projects": _id
}
175 if self
.db
.get_list("users", _filter
):
176 raise EngineException("There is some USER that contains this project", http_code
=HTTPStatus
.CONFLICT
)
178 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
179 if not session
["admin"]:
180 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
181 # Names that look like UUIDs are not allowed
182 name
= (indata
if indata
else kwargs
).get("name")
183 if is_valid_uuid(name
):
184 raise EngineException("Project names that look like UUIDs are not allowed",
185 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
186 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
188 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
189 if not session
["admin"]:
190 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
191 # Names that look like UUIDs are not allowed
192 name
= indata
["name"] if indata
else kwargs
["name"]
193 if is_valid_uuid(name
):
194 raise EngineException("Project names that look like UUIDs are not allowed",
195 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
196 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
199 class CommonVimWimSdn(BaseTopic
):
200 """Common class for VIM, WIM SDN just to unify methods that are equal to all of them"""
201 config_to_encrypt
= {} # what keys at config must be encrypted because contains passwords
202 password_to_encrypt
= "" # key that contains a password
205 def _create_operation(op_type
, params
=None):
207 Creates a dictionary with the information to an operation, similar to ns-lcm-op
208 :param op_type: can be create, edit, delete
209 :param params: operation input parameters
210 :return: new dictionary with
214 "lcmOperationType": op_type
,
215 "operationState": "PROCESSING",
217 "statusEnteredTime": now
,
218 "detailed-status": "",
219 "operationParams": params
,
222 def check_conflict_on_new(self
, session
, indata
):
224 Check that the data to be inserted is valid. It is checked that name is unique
225 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
226 :param indata: data to be inserted
227 :return: None or raises EngineException
229 self
.check_unique_name(session
, indata
["name"], _id
=None)
231 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
233 Check that the data to be edited/uploaded is valid. It is checked that name is unique
234 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
235 :param final_content: data once modified. This method may change it.
236 :param edit_content: incremental data that contains the modifications to apply
237 :param _id: internal _id
238 :return: None or raises EngineException
240 if not session
["force"] and edit_content
.get("name"):
241 self
.check_unique_name(session
, edit_content
["name"], _id
=_id
)
243 def format_on_edit(self
, final_content
, edit_content
):
245 Modifies final_content inserting admin information upon edition
246 :param final_content: final content to be stored at database
247 :param edit_content: user requested update content
248 :return: operation id
252 schema_version
= final_content
.get("schema_version")
254 if edit_content
.get(self
.password_to_encrypt
):
255 final_content
[self
.password_to_encrypt
] = self
.db
.encrypt(edit_content
[self
.password_to_encrypt
],
256 schema_version
=schema_version
,
257 salt
=final_content
["_id"])
258 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
259 if edit_content
.get("config") and config_to_encrypt_keys
:
261 for p
in config_to_encrypt_keys
:
262 if edit_content
["config"].get(p
):
263 final_content
["config"][p
] = self
.db
.encrypt(edit_content
["config"][p
],
264 schema_version
=schema_version
,
265 salt
=final_content
["_id"])
267 # create edit operation
268 final_content
["_admin"]["operations"].append(self
._create
_operation
("edit"))
269 return "{}:{}".format(final_content
["_id"], len(final_content
["_admin"]["operations"]) - 1)
271 def format_on_new(self
, content
, project_id
=None, make_public
=False):
273 Modifies content descriptor to include _admin and insert create operation
274 :param content: descriptor to be modified
275 :param project_id: if included, it add project read/write permissions. Can be None or a list
276 :param make_public: if included it is generated as public for reading.
277 :return: op_id: operation id on asynchronous operation, None otherwise. In addition content is modified
279 super().format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
280 content
["schema_version"] = schema_version
= "1.11"
283 if content
.get(self
.password_to_encrypt
):
284 content
[self
.password_to_encrypt
] = self
.db
.encrypt(content
[self
.password_to_encrypt
],
285 schema_version
=schema_version
,
287 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
288 if content
.get("config") and config_to_encrypt_keys
:
289 for p
in config_to_encrypt_keys
:
290 if content
["config"].get(p
):
291 content
["config"][p
] = self
.db
.encrypt(content
["config"][p
],
292 schema_version
=schema_version
,
295 content
["_admin"]["operationalState"] = "PROCESSING"
298 content
["_admin"]["operations"] = [self
._create
_operation
("create")]
299 content
["_admin"]["current_operation"] = None
301 return "{}:0".format(content
["_id"])
303 def delete(self
, session
, _id
, dry_run
=False):
305 Delete item by its internal _id
306 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
307 :param _id: server internal id
308 :param dry_run: make checking but do not delete
309 :return: operation id if it is ordered to delete. None otherwise
312 filter_q
= self
._get
_project
_filter
(session
)
313 filter_q
["_id"] = _id
314 db_content
= self
.db
.get_one(self
.topic
, filter_q
)
316 self
.check_conflict_on_del(session
, _id
, db_content
)
320 # remove reference from project_read. If not last delete
321 if session
["project_id"]:
322 for project_id
in session
["project_id"]:
323 if project_id
in db_content
["_admin"]["projects_read"]:
324 db_content
["_admin"]["projects_read"].remove(project_id
)
325 if project_id
in db_content
["_admin"]["projects_write"]:
326 db_content
["_admin"]["projects_write"].remove(project_id
)
328 db_content
["_admin"]["projects_read"].clear()
329 db_content
["_admin"]["projects_write"].clear()
331 update_dict
= {"_admin.projects_read": db_content
["_admin"]["projects_read"],
332 "_admin.projects_write": db_content
["_admin"]["projects_write"]
335 # check if there are projects referencing it (apart from ANY that means public)....
336 if db_content
["_admin"]["projects_read"] and (len(db_content
["_admin"]["projects_read"]) > 1 or
337 db_content
["_admin"]["projects_read"][0] != "ANY"):
338 self
.db
.set_one(self
.topic
, filter_q
, update_dict
=update_dict
) # remove references but not delete
343 self
.db
.del_one(self
.topic
, {"_id": _id
})
345 self
._send
_msg
("deleted", {"_id": _id
, "op_id": op_id
})
347 update_dict
["_admin.to_delete"] = True
348 self
.db
.set_one(self
.topic
, {"_id": _id
},
349 update_dict
=update_dict
,
350 push
={"_admin.operations": self
._create
_operation
("delete")}
352 # the number of operations is the operation_id. db_content does not contains the new operation inserted,
353 # so the -1 is not needed
354 op_id
= "{}:{}".format(db_content
["_id"], len(db_content
["_admin"]["operations"]))
355 self
._send
_msg
("delete", {"_id": _id
, "op_id": op_id
})
359 class VimAccountTopic(CommonVimWimSdn
):
360 topic
= "vim_accounts"
361 topic_msg
= "vim_account"
362 schema_new
= vim_account_new_schema
363 schema_edit
= vim_account_edit_schema
365 password_to_encrypt
= "vim_password"
366 config_to_encrypt
= {"1.1": ("admin_password", "nsx_password", "vcenter_password"),
367 "default": ("admin_password", "nsx_password", "vcenter_password", "vrops_password")}
370 class WimAccountTopic(CommonVimWimSdn
):
371 topic
= "wim_accounts"
372 topic_msg
= "wim_account"
373 schema_new
= wim_account_new_schema
374 schema_edit
= wim_account_edit_schema
376 password_to_encrypt
= "wim_password"
377 config_to_encrypt
= {}
380 class SdnTopic(CommonVimWimSdn
):
383 schema_new
= sdn_new_schema
384 schema_edit
= sdn_edit_schema
386 password_to_encrypt
= "password"
387 config_to_encrypt
= {}
390 class UserTopicAuth(UserTopic
):
392 # topic_msg = "users"
393 schema_new
= user_new_schema
394 schema_edit
= user_edit_schema
396 def __init__(self
, db
, fs
, msg
, auth
):
397 UserTopic
.__init
__(self
, db
, fs
, msg
)
400 def check_conflict_on_new(self
, session
, indata
):
402 Check that the data to be inserted is valid
404 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
405 :param indata: data to be inserted
406 :return: None or raises EngineException
408 username
= indata
.get("username")
409 if is_valid_uuid(username
):
410 raise EngineException("username '{}' cannot have a uuid format".format(username
),
411 HTTPStatus
.UNPROCESSABLE_ENTITY
)
413 # Check that username is not used, regardless keystone already checks this
414 if self
.auth
.get_user_list(filter_q
={"name": username
}):
415 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
417 if "projects" in indata
.keys():
418 # convert to new format project_role_mappings
419 role
= self
.auth
.get_role_list({"name": "project_admin"})
421 role
= self
.auth
.get_role_list()
423 raise AuthconnNotFoundException("Can't find default role for user '{}'".format(username
))
425 if not indata
.get("project_role_mappings"):
426 indata
["project_role_mappings"] = []
427 for project
in indata
["projects"]:
428 pid
= self
.auth
.get_project(project
)["_id"]
429 prm
= {"project": pid
, "role": rid
}
430 if prm
not in indata
["project_role_mappings"]:
431 indata
["project_role_mappings"].append(prm
)
432 # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
433 # HTTPStatus.BAD_REQUEST)
435 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
437 Check that the data to be edited/uploaded is valid
439 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
440 :param final_content: data once modified
441 :param edit_content: incremental data that contains the modifications to apply
442 :param _id: internal _id
443 :return: None or raises EngineException
446 if "username" in edit_content
:
447 username
= edit_content
.get("username")
448 if is_valid_uuid(username
):
449 raise EngineException("username '{}' cannot have an uuid format".format(username
),
450 HTTPStatus
.UNPROCESSABLE_ENTITY
)
452 # Check that username is not used, regardless keystone already checks this
453 if self
.auth
.get_user_list(filter_q
={"name": username
}):
454 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
456 if final_content
["username"] == "admin":
457 for mapping
in edit_content
.get("remove_project_role_mappings", ()):
458 if mapping
["project"] == "admin" and mapping
.get("role") in (None, "system_admin"):
459 # TODO make this also available for project id and role id
460 raise EngineException("You cannot remove system_admin role from admin user",
461 http_code
=HTTPStatus
.FORBIDDEN
)
463 def check_conflict_on_del(self
, session
, _id
, db_content
):
465 Check if deletion can be done because of dependencies if it is not force. To override
466 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
467 :param _id: internal _id
468 :param db_content: The database content of this item _id
469 :return: None if ok or raises EngineException with the conflict
471 if db_content
["username"] == session
["username"]:
472 raise EngineException("You cannot delete your own login user ", http_code
=HTTPStatus
.CONFLICT
)
473 # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
476 def format_on_show(content
):
478 Modifies the content of the role information to separate the role
479 metadata from the role definition.
481 project_role_mappings
= []
483 if "projects" in content
:
484 for project
in content
["projects"]:
485 for role
in project
["roles"]:
486 project_role_mappings
.append({"project": project
["_id"],
487 "project_name": project
["name"],
489 "role_name": role
["name"]})
490 del content
["projects"]
491 content
["project_role_mappings"] = project_role_mappings
495 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
497 Creates a new entry into the authentication backend.
499 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
501 :param rollback: list to append created items at database in case a rollback may to be done
502 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
503 :param indata: data to be inserted
504 :param kwargs: used to override the indata descriptor
505 :param headers: http request headers
506 :return: _id: identity of the inserted data, operation _id (None)
509 content
= BaseTopic
._remove
_envelop
(indata
)
511 # Override descriptor with query string kwargs
512 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
513 content
= self
._validate
_input
_new
(content
, session
["force"])
514 self
.check_conflict_on_new(session
, content
)
515 # self.format_on_new(content, session["project_id"], make_public=session["public"])
517 content
["_admin"] = {"created": now
, "modified": now
}
519 for prm
in content
.get("project_role_mappings", []):
520 proj
= self
.auth
.get_project(prm
["project"], not session
["force"])
521 role
= self
.auth
.get_role(prm
["role"], not session
["force"])
522 pid
= proj
["_id"] if proj
else None
523 rid
= role
["_id"] if role
else None
524 prl
= {"project": pid
, "role": rid
}
527 content
["project_role_mappings"] = prms
528 # _id = self.auth.create_user(content["username"], content["password"])["_id"]
529 _id
= self
.auth
.create_user(content
)["_id"]
531 rollback
.append({"topic": self
.topic
, "_id": _id
})
532 # del content["password"]
533 # self._send_msg("create", content)
535 except ValidationError
as e
:
536 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
538 def show(self
, session
, _id
):
540 Get complete information on an topic
542 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
543 :param _id: server internal id
544 :return: dictionary, raise exception if not found.
546 # Allow _id to be a name or uuid
547 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
548 users
= self
.auth
.get_user_list(filter_q
)
553 raise EngineException("Too many users found", HTTPStatus
.CONFLICT
)
555 raise EngineException("User not found", HTTPStatus
.NOT_FOUND
)
557 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
559 Updates an user entry.
561 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
563 :param indata: data to be inserted
564 :param kwargs: used to override the indata descriptor
566 :return: _id: identity of the inserted data.
568 indata
= self
._remove
_envelop
(indata
)
570 # Override descriptor with query string kwargs
572 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
574 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
577 content
= self
.show(session
, _id
)
578 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
579 # self.format_on_edit(content, indata)
581 if not ("password" in indata
or "username" in indata
or indata
.get("remove_project_role_mappings") or
582 indata
.get("add_project_role_mappings") or indata
.get("project_role_mappings") or
583 indata
.get("projects") or indata
.get("add_projects")):
585 if indata
.get("project_role_mappings") \
586 and (indata
.get("remove_project_role_mappings") or indata
.get("add_project_role_mappings")):
587 raise EngineException("Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
588 "' or 'remove_project_role_mappings'", http_code
=HTTPStatus
.BAD_REQUEST
)
590 if indata
.get("projects") or indata
.get("add_projects"):
591 role
= self
.auth
.get_role_list({"name": "project_admin"})
593 role
= self
.auth
.get_role_list()
595 raise AuthconnNotFoundException("Can't find a default role for user '{}'"
596 .format(content
["username"]))
598 if "add_project_role_mappings" not in indata
:
599 indata
["add_project_role_mappings"] = []
600 if "remove_project_role_mappings" not in indata
:
601 indata
["remove_project_role_mappings"] = []
602 if isinstance(indata
.get("projects"), dict):
603 # backward compatible
604 for k
, v
in indata
["projects"].items():
605 if k
.startswith("$") and v
is None:
606 indata
["remove_project_role_mappings"].append({"project": k
[1:]})
607 elif k
.startswith("$+"):
608 indata
["add_project_role_mappings"].append({"project": v
, "role": rid
})
609 del indata
["projects"]
610 for proj
in indata
.get("projects", []) + indata
.get("add_projects", []):
611 indata
["add_project_role_mappings"].append({"project": proj
, "role": rid
})
613 # user = self.show(session, _id) # Already in 'content'
614 original_mapping
= content
["project_role_mappings"]
617 mappings_to_remove
= []
620 for to_remove
in indata
.get("remove_project_role_mappings", ()):
621 for mapping
in original_mapping
:
622 if to_remove
["project"] in (mapping
["project"], mapping
["project_name"]):
623 if not to_remove
.get("role") or to_remove
["role"] in (mapping
["role"], mapping
["role_name"]):
624 mappings_to_remove
.append(mapping
)
627 for to_add
in indata
.get("add_project_role_mappings", ()):
628 for mapping
in original_mapping
:
629 if to_add
["project"] in (mapping
["project"], mapping
["project_name"]) and \
630 to_add
["role"] in (mapping
["role"], mapping
["role_name"]):
632 if mapping
in mappings_to_remove
: # do not remove
633 mappings_to_remove
.remove(mapping
)
634 break # do not add, it is already at user
636 pid
= self
.auth
.get_project(to_add
["project"])["_id"]
637 rid
= self
.auth
.get_role(to_add
["role"])["_id"]
638 mappings_to_add
.append({"project": pid
, "role": rid
})
641 if indata
.get("project_role_mappings"):
642 for to_set
in indata
["project_role_mappings"]:
643 for mapping
in original_mapping
:
644 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
645 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
646 if mapping
in mappings_to_remove
: # do not remove
647 mappings_to_remove
.remove(mapping
)
648 break # do not add, it is already at user
650 pid
= self
.auth
.get_project(to_set
["project"])["_id"]
651 rid
= self
.auth
.get_role(to_set
["role"])["_id"]
652 mappings_to_add
.append({"project": pid
, "role": rid
})
653 for mapping
in original_mapping
:
654 for to_set
in indata
["project_role_mappings"]:
655 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
656 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
660 if mapping
not in mappings_to_remove
: # do not remove
661 mappings_to_remove
.append(mapping
)
663 self
.auth
.update_user({"_id": _id
, "username": indata
.get("username"), "password": indata
.get("password"),
664 "add_project_role_mappings": mappings_to_add
,
665 "remove_project_role_mappings": mappings_to_remove
669 except ValidationError
as e
:
670 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
672 def list(self
, session
, filter_q
=None):
674 Get a list of the topic that matches a filter
675 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
676 :param filter_q: filter of data to be applied
677 :return: The list, it can be empty if no one match the filter.
679 users
= self
.auth
.get_user_list(filter_q
)
683 def delete(self
, session
, _id
, dry_run
=False):
685 Delete item by its internal _id
687 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
688 :param _id: server internal id
689 :param force: indicates if deletion must be forced in case of conflict
690 :param dry_run: make checking but do not delete
691 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
693 # Allow _id to be a name or uuid
694 user
= self
.auth
.get_user(_id
)
696 self
.check_conflict_on_del(session
, uid
, user
)
698 v
= self
.auth
.delete_user(uid
)
703 class ProjectTopicAuth(ProjectTopic
):
705 # topic_msg = "projects"
706 schema_new
= project_new_schema
707 schema_edit
= project_edit_schema
709 def __init__(self
, db
, fs
, msg
, auth
):
710 ProjectTopic
.__init
__(self
, db
, fs
, msg
)
713 def check_conflict_on_new(self
, session
, indata
):
715 Check that the data to be inserted is valid
717 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
718 :param indata: data to be inserted
719 :return: None or raises EngineException
721 project_name
= indata
.get("name")
722 if is_valid_uuid(project_name
):
723 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
724 HTTPStatus
.UNPROCESSABLE_ENTITY
)
726 project_list
= self
.auth
.get_project_list(filter_q
={"name": project_name
})
729 raise EngineException("project '{}' exists".format(project_name
), HTTPStatus
.CONFLICT
)
731 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
733 Check that the data to be edited/uploaded is valid
735 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
736 :param final_content: data once modified
737 :param edit_content: incremental data that contains the modifications to apply
738 :param _id: internal _id
739 :return: None or raises EngineException
742 project_name
= edit_content
.get("name")
743 if project_name
!= final_content
["name"]: # It is a true renaming
744 if is_valid_uuid(project_name
):
745 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
746 HTTPStatus
.UNPROCESSABLE_ENTITY
)
748 if final_content
["name"] == "admin":
749 raise EngineException("You cannot rename project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
751 # Check that project name is not used, regardless keystone already checks this
752 if self
.auth
.get_project_list(filter_q
={"name": project_name
}):
753 raise EngineException("project '{}' is already used".format(project_name
), HTTPStatus
.CONFLICT
)
755 def check_conflict_on_del(self
, session
, _id
, db_content
):
757 Check if deletion can be done because of dependencies if it is not force. To override
759 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
760 :param _id: internal _id
761 :param db_content: The database content of this item _id
762 :return: None if ok or raises EngineException with the conflict
765 def check_rw_projects(topic
, title
, id_field
):
766 for desc
in self
.db
.get_list(topic
):
767 if _id
in desc
["_admin"]["projects_read"] + desc
["_admin"]["projects_write"]:
768 raise EngineException("Project '{}' ({}) is being used by {} '{}'"
769 .format(db_content
["name"], _id
, title
, desc
[id_field
]), HTTPStatus
.CONFLICT
)
771 if _id
in session
["project_id"]:
772 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
774 if db_content
["name"] == "admin":
775 raise EngineException("You cannot delete project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
777 # If any user is using this project, raise CONFLICT exception
778 if not session
["force"]:
779 for user
in self
.auth
.get_user_list():
780 for prm
in user
.get("project_role_mappings"):
781 if prm
["project"] == _id
:
782 raise EngineException("Project '{}' ({}) is being used by user '{}'"
783 .format(db_content
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
785 # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
786 if not session
["force"]:
787 check_rw_projects("vnfds", "VNF Descriptor", "id")
788 check_rw_projects("nsds", "NS Descriptor", "id")
789 check_rw_projects("nsts", "NS Template", "id")
790 check_rw_projects("pdus", "PDU Descriptor", "name")
792 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
794 Creates a new entry into the authentication backend.
796 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
798 :param rollback: list to append created items at database in case a rollback may to be done
799 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
800 :param indata: data to be inserted
801 :param kwargs: used to override the indata descriptor
802 :param headers: http request headers
803 :return: _id: identity of the inserted data, operation _id (None)
806 content
= BaseTopic
._remove
_envelop
(indata
)
808 # Override descriptor with query string kwargs
809 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
810 content
= self
._validate
_input
_new
(content
, session
["force"])
811 self
.check_conflict_on_new(session
, content
)
812 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
813 _id
= self
.auth
.create_project(content
)
814 rollback
.append({"topic": self
.topic
, "_id": _id
})
815 # self._send_msg("create", content)
817 except ValidationError
as e
:
818 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
820 def show(self
, session
, _id
):
822 Get complete information on an topic
824 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
825 :param _id: server internal id
826 :return: dictionary, raise exception if not found.
828 # Allow _id to be a name or uuid
829 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
830 projects
= self
.auth
.get_project_list(filter_q
=filter_q
)
832 if len(projects
) == 1:
834 elif len(projects
) > 1:
835 raise EngineException("Too many projects found", HTTPStatus
.CONFLICT
)
837 raise EngineException("Project not found", HTTPStatus
.NOT_FOUND
)
839 def list(self
, session
, filter_q
=None):
841 Get a list of the topic that matches a filter
843 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
844 :param filter_q: filter of data to be applied
845 :return: The list, it can be empty if no one match the filter.
847 return self
.auth
.get_project_list(filter_q
)
849 def delete(self
, session
, _id
, dry_run
=False):
851 Delete item by its internal _id
853 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
854 :param _id: server internal id
855 :param dry_run: make checking but do not delete
856 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
858 # Allow _id to be a name or uuid
859 proj
= self
.auth
.get_project(_id
)
861 self
.check_conflict_on_del(session
, pid
, proj
)
863 v
= self
.auth
.delete_project(pid
)
867 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
869 Updates a project entry.
871 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
873 :param indata: data to be inserted
874 :param kwargs: used to override the indata descriptor
876 :return: _id: identity of the inserted data.
878 indata
= self
._remove
_envelop
(indata
)
880 # Override descriptor with query string kwargs
882 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
884 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
887 content
= self
.show(session
, _id
)
888 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
889 self
.format_on_edit(content
, indata
)
892 content
["name"] = indata
["name"]
893 self
.auth
.update_project(content
["_id"], content
)
894 except ValidationError
as e
:
895 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
898 class RoleTopicAuth(BaseTopic
):
900 topic_msg
= None # "roles"
901 schema_new
= roles_new_schema
902 schema_edit
= roles_edit_schema
905 def __init__(self
, db
, fs
, msg
, auth
, ops
):
906 BaseTopic
.__init
__(self
, db
, fs
, msg
)
908 self
.operations
= ops
909 # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
912 def validate_role_definition(operations
, role_definitions
):
914 Validates the role definition against the operations defined in
915 the resources to operations files.
917 :param operations: operations list
918 :param role_definitions: role definition to test
919 :return: None if ok, raises ValidationError exception on error
921 if not role_definitions
.get("permissions"):
923 ignore_fields
= ["admin", "default"]
924 for role_def
in role_definitions
["permissions"].keys():
925 if role_def
in ignore_fields
:
927 if role_def
[-1] == ":":
928 raise ValidationError("Operation cannot end with ':'")
930 role_def_matches
= [op
for op
in operations
if op
.startswith(role_def
)]
932 if len(role_def_matches
) == 0:
933 raise ValidationError("Invalid permission '{}'".format(role_def
))
935 def _validate_input_new(self
, input, force
=False):
937 Validates input user content for a new entry.
939 :param input: user input content for the new topic
940 :param force: may be used for being more tolerant
941 :return: The same input content, or a changed version of it.
944 validate_input(input, self
.schema_new
)
945 self
.validate_role_definition(self
.operations
, input)
949 def _validate_input_edit(self
, input, force
=False):
951 Validates input user content for updating an entry.
953 :param input: user input content for the new topic
954 :param force: may be used for being more tolerant
955 :return: The same input content, or a changed version of it.
958 validate_input(input, self
.schema_edit
)
959 self
.validate_role_definition(self
.operations
, input)
963 def check_conflict_on_new(self
, session
, indata
):
965 Check that the data to be inserted is valid
967 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
968 :param indata: data to be inserted
969 :return: None or raises EngineException
971 # check name not exists
972 name
= indata
["name"]
973 # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
974 if self
.auth
.get_role_list({"name": name
}):
975 raise EngineException("role name '{}' exists".format(name
), HTTPStatus
.CONFLICT
)
977 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
979 Check that the data to be edited/uploaded is valid
981 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
982 :param final_content: data once modified
983 :param edit_content: incremental data that contains the modifications to apply
984 :param _id: internal _id
985 :return: None or raises EngineException
987 if "default" not in final_content
["permissions"]:
988 final_content
["permissions"]["default"] = False
989 if "admin" not in final_content
["permissions"]:
990 final_content
["permissions"]["admin"] = False
992 # check name not exists
993 if "name" in edit_content
:
994 role_name
= edit_content
["name"]
995 # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
996 roles
= self
.auth
.get_role_list({"name": role_name
})
997 if roles
and roles
[0][BaseTopic
.id_field("roles", _id
)] != _id
:
998 raise EngineException("role name '{}' exists".format(role_name
), HTTPStatus
.CONFLICT
)
1000 def check_conflict_on_del(self
, session
, _id
, db_content
):
1002 Check if deletion can be done because of dependencies if it is not force. To override
1004 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1005 :param _id: internal _id
1006 :param db_content: The database content of this item _id
1007 :return: None if ok or raises EngineException with the conflict
1009 role
= self
.auth
.get_role(_id
)
1010 if role
["name"] in ["system_admin", "project_admin"]:
1011 raise EngineException("You cannot delete role '{}'".format(role
["name"]), http_code
=HTTPStatus
.FORBIDDEN
)
1013 # If any user is using this role, raise CONFLICT exception
1014 for user
in self
.auth
.get_user_list():
1015 for prm
in user
.get("project_role_mappings"):
1016 if prm
["role"] == _id
:
1017 raise EngineException("Role '{}' ({}) is being used by user '{}'"
1018 .format(role
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
1021 def format_on_new(content
, project_id
=None, make_public
=False): # TO BE REMOVED ?
1023 Modifies content descriptor to include _admin
1025 :param content: descriptor to be modified
1026 :param project_id: if included, it add project read/write permissions
1027 :param make_public: if included it is generated as public for reading.
1028 :return: None, but content is modified
1031 if "_admin" not in content
:
1032 content
["_admin"] = {}
1033 if not content
["_admin"].get("created"):
1034 content
["_admin"]["created"] = now
1035 content
["_admin"]["modified"] = now
1037 if "permissions" not in content
:
1038 content
["permissions"] = {}
1040 if "default" not in content
["permissions"]:
1041 content
["permissions"]["default"] = False
1042 if "admin" not in content
["permissions"]:
1043 content
["permissions"]["admin"] = False
1046 def format_on_edit(final_content
, edit_content
):
1048 Modifies final_content descriptor to include the modified date.
1050 :param final_content: final descriptor generated
1051 :param edit_content: alterations to be include
1052 :return: None, but final_content is modified
1054 if "_admin" in final_content
:
1055 final_content
["_admin"]["modified"] = time()
1057 if "permissions" not in final_content
:
1058 final_content
["permissions"] = {}
1060 if "default" not in final_content
["permissions"]:
1061 final_content
["permissions"]["default"] = False
1062 if "admin" not in final_content
["permissions"]:
1063 final_content
["permissions"]["admin"] = False
1066 def show(self
, session
, _id
):
1068 Get complete information on an topic
1070 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1071 :param _id: server internal id
1072 :return: dictionary, raise exception if not found.
1074 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1075 roles
= self
.auth
.get_role_list(filter_q
)
1077 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1078 elif len(roles
) > 1:
1079 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1082 def list(self
, session
, filter_q
=None):
1084 Get a list of the topic that matches a filter
1086 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1087 :param filter_q: filter of data to be applied
1088 :return: The list, it can be empty if no one match the filter.
1090 return self
.auth
.get_role_list(filter_q
)
1092 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1094 Creates a new entry into database.
1096 :param rollback: list to append created items at database in case a rollback may to be done
1097 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1098 :param indata: data to be inserted
1099 :param kwargs: used to override the indata descriptor
1100 :param headers: http request headers
1101 :return: _id: identity of the inserted data, operation _id (None)
1104 content
= self
._remove
_envelop
(indata
)
1106 # Override descriptor with query string kwargs
1107 self
._update
_input
_with
_kwargs
(content
, kwargs
)
1108 content
= self
._validate
_input
_new
(content
, session
["force"])
1109 self
.check_conflict_on_new(session
, content
)
1110 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
1111 # role_name = content["name"]
1112 rid
= self
.auth
.create_role(content
)
1113 content
["_id"] = rid
1114 # _id = self.db.create(self.topic, content)
1115 rollback
.append({"topic": self
.topic
, "_id": rid
})
1116 # self._send_msg("create", content)
1118 except ValidationError
as e
:
1119 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1121 def delete(self
, session
, _id
, dry_run
=False):
1123 Delete item by its internal _id
1125 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1126 :param _id: server internal id
1127 :param dry_run: make checking but do not delete
1128 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1130 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1131 roles
= self
.auth
.get_role_list(filter_q
)
1133 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1134 elif len(roles
) > 1:
1135 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1136 rid
= roles
[0]["_id"]
1137 self
.check_conflict_on_del(session
, rid
, None)
1138 # filter_q = {"_id": _id}
1139 # filter_q = {BaseTopic.id_field(self.topic, _id): _id} # To allow role addressing by name
1141 v
= self
.auth
.delete_role(rid
)
1142 # v = self.db.del_one(self.topic, filter_q)
1146 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1148 Updates a role entry.
1150 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1152 :param indata: data to be inserted
1153 :param kwargs: used to override the indata descriptor
1155 :return: _id: identity of the inserted data.
1158 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1160 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
1162 content
= self
.show(session
, _id
)
1163 deep_update_rfc7396(content
, indata
)
1164 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1165 self
.format_on_edit(content
, indata
)
1166 self
.auth
.update_role(content
)
1167 except ValidationError
as e
:
1168 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)