1 # -*- coding: utf-8 -*-
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from uuid
import uuid4
18 from hashlib
import sha256
19 from http
import HTTPStatus
21 from osm_nbi
.validation
import user_new_schema
, user_edit_schema
, project_new_schema
, project_edit_schema
, \
22 vim_account_new_schema
, vim_account_edit_schema
, sdn_new_schema
, sdn_edit_schema
, \
23 wim_account_new_schema
, wim_account_edit_schema
, roles_new_schema
, roles_edit_schema
, \
24 k8scluster_new_schema
, k8scluster_edit_schema
, k8srepo_new_schema
, k8srepo_edit_schema
, \
25 validate_input
, ValidationError
, is_valid_uuid
# To check that User/Project Names don't look like UUIDs
26 from osm_nbi
.base_topic
import BaseTopic
, EngineException
27 from osm_nbi
.authconn
import AuthconnNotFoundException
, AuthconnConflictException
28 from osm_common
.dbbase
import deep_update_rfc7396
30 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
33 class UserTopic(BaseTopic
):
36 schema_new
= user_new_schema
37 schema_edit
= user_edit_schema
40 def __init__(self
, db
, fs
, msg
, auth
):
41 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
44 def _get_project_filter(session
):
46 Generates a filter dictionary for querying database users.
47 Current policy is admin can show all, non admin, only its own user.
48 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
51 if session
["admin"]: # allows all
54 return {"username": session
["username"]}
56 def check_conflict_on_new(self
, session
, indata
):
57 # check username not exists
58 if self
.db
.get_one(self
.topic
, {"username": indata
.get("username")}, fail_on_empty
=False, fail_on_more
=False):
59 raise EngineException("username '{}' exists".format(indata
["username"]), HTTPStatus
.CONFLICT
)
61 if not session
["force"]:
62 for p
in indata
.get("projects") or []:
63 # To allow project addressing by Name as well as ID
64 if not self
.db
.get_one("projects", {BaseTopic
.id_field("projects", p
): p
}, fail_on_empty
=False,
66 raise EngineException("project '{}' does not exist".format(p
), HTTPStatus
.CONFLICT
)
68 def check_conflict_on_del(self
, session
, _id
, db_content
):
70 Check if deletion can be done because of dependencies if it is not force. To override
71 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
72 :param _id: internal _id
73 :param db_content: The database content of this item _id
74 :return: None if ok or raises EngineException with the conflict
76 if _id
== session
["username"]:
77 raise EngineException("You cannot delete your own user", http_code
=HTTPStatus
.CONFLICT
)
80 def format_on_new(content
, project_id
=None, make_public
=False):
81 BaseTopic
.format_on_new(content
, make_public
=False)
82 # Removed so that the UUID is kept, to allow User Name modification
83 # content["_id"] = content["username"]
85 content
["_admin"]["salt"] = salt
86 if content
.get("password"):
87 content
["password"] = sha256(content
["password"].encode('utf-8') + salt
.encode('utf-8')).hexdigest()
88 if content
.get("project_role_mappings"):
89 projects
= [mapping
["project"] for mapping
in content
["project_role_mappings"]]
91 if content
.get("projects"):
92 content
["projects"] += projects
94 content
["projects"] = projects
97 def format_on_edit(final_content
, edit_content
):
98 BaseTopic
.format_on_edit(final_content
, edit_content
)
99 if edit_content
.get("password"):
101 final_content
["_admin"]["salt"] = salt
102 final_content
["password"] = sha256(edit_content
["password"].encode('utf-8') +
103 salt
.encode('utf-8')).hexdigest()
106 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
107 if not session
["admin"]:
108 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
109 # Names that look like UUIDs are not allowed
110 name
= (indata
if indata
else kwargs
).get("username")
111 if is_valid_uuid(name
):
112 raise EngineException("Usernames that look like UUIDs are not allowed",
113 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
114 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
116 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
117 if not session
["admin"]:
118 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
119 # Names that look like UUIDs are not allowed
120 name
= indata
["username"] if indata
else kwargs
["username"]
121 if is_valid_uuid(name
):
122 raise EngineException("Usernames that look like UUIDs are not allowed",
123 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
124 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
127 class ProjectTopic(BaseTopic
):
129 topic_msg
= "projects"
130 schema_new
= project_new_schema
131 schema_edit
= project_edit_schema
134 def __init__(self
, db
, fs
, msg
, auth
):
135 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
138 def _get_project_filter(session
):
140 Generates a filter dictionary for querying database users.
141 Current policy is admin can show all, non admin, only its own user.
142 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
145 if session
["admin"]: # allows all
148 return {"_id.cont": session
["project_id"]}
150 def check_conflict_on_new(self
, session
, indata
):
151 if not indata
.get("name"):
152 raise EngineException("missing 'name'")
153 # check name not exists
154 if self
.db
.get_one(self
.topic
, {"name": indata
.get("name")}, fail_on_empty
=False, fail_on_more
=False):
155 raise EngineException("name '{}' exists".format(indata
["name"]), HTTPStatus
.CONFLICT
)
158 def format_on_new(content
, project_id
=None, make_public
=False):
159 BaseTopic
.format_on_new(content
, None)
160 # Removed so that the UUID is kept, to allow Project Name modification
161 # content["_id"] = content["name"]
163 def check_conflict_on_del(self
, session
, _id
, db_content
):
165 Check if deletion can be done because of dependencies if it is not force. To override
166 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
167 :param _id: internal _id
168 :param db_content: The database content of this item _id
169 :return: None if ok or raises EngineException with the conflict
171 if _id
in session
["project_id"]:
172 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
175 _filter
= {"projects": _id
}
176 if self
.db
.get_list("users", _filter
):
177 raise EngineException("There is some USER that contains this project", http_code
=HTTPStatus
.CONFLICT
)
179 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
180 if not session
["admin"]:
181 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
182 # Names that look like UUIDs are not allowed
183 name
= (indata
if indata
else kwargs
).get("name")
184 if is_valid_uuid(name
):
185 raise EngineException("Project names that look like UUIDs are not allowed",
186 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
187 return BaseTopic
.edit(self
, session
, _id
, indata
=indata
, kwargs
=kwargs
, content
=content
)
189 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
190 if not session
["admin"]:
191 raise EngineException("needed admin privileges", http_code
=HTTPStatus
.UNAUTHORIZED
)
192 # Names that look like UUIDs are not allowed
193 name
= indata
["name"] if indata
else kwargs
["name"]
194 if is_valid_uuid(name
):
195 raise EngineException("Project names that look like UUIDs are not allowed",
196 http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
)
197 return BaseTopic
.new(self
, rollback
, session
, indata
=indata
, kwargs
=kwargs
, headers
=headers
)
200 class CommonVimWimSdn(BaseTopic
):
201 """Common class for VIM, WIM SDN just to unify methods that are equal to all of them"""
202 config_to_encrypt
= {} # what keys at config must be encrypted because contains passwords
203 password_to_encrypt
= "" # key that contains a password
206 def _create_operation(op_type
, params
=None):
208 Creates a dictionary with the information to an operation, similar to ns-lcm-op
209 :param op_type: can be create, edit, delete
210 :param params: operation input parameters
211 :return: new dictionary with
215 "lcmOperationType": op_type
,
216 "operationState": "PROCESSING",
218 "statusEnteredTime": now
,
219 "detailed-status": "",
220 "operationParams": params
,
223 def check_conflict_on_new(self
, session
, indata
):
225 Check that the data to be inserted is valid. It is checked that name is unique
226 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
227 :param indata: data to be inserted
228 :return: None or raises EngineException
230 self
.check_unique_name(session
, indata
["name"], _id
=None)
232 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
234 Check that the data to be edited/uploaded is valid. It is checked that name is unique
235 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
236 :param final_content: data once modified. This method may change it.
237 :param edit_content: incremental data that contains the modifications to apply
238 :param _id: internal _id
239 :return: None or raises EngineException
241 if not session
["force"] and edit_content
.get("name"):
242 self
.check_unique_name(session
, edit_content
["name"], _id
=_id
)
244 def format_on_edit(self
, final_content
, edit_content
):
246 Modifies final_content inserting admin information upon edition
247 :param final_content: final content to be stored at database
248 :param edit_content: user requested update content
249 :return: operation id
251 super().format_on_edit(final_content
, edit_content
)
254 schema_version
= final_content
.get("schema_version")
256 if edit_content
.get(self
.password_to_encrypt
):
257 final_content
[self
.password_to_encrypt
] = self
.db
.encrypt(edit_content
[self
.password_to_encrypt
],
258 schema_version
=schema_version
,
259 salt
=final_content
["_id"])
260 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
261 if edit_content
.get("config") and config_to_encrypt_keys
:
263 for p
in config_to_encrypt_keys
:
264 if edit_content
["config"].get(p
):
265 final_content
["config"][p
] = self
.db
.encrypt(edit_content
["config"][p
],
266 schema_version
=schema_version
,
267 salt
=final_content
["_id"])
269 # create edit operation
270 final_content
["_admin"]["operations"].append(self
._create
_operation
("edit"))
271 return "{}:{}".format(final_content
["_id"], len(final_content
["_admin"]["operations"]) - 1)
273 def format_on_new(self
, content
, project_id
=None, make_public
=False):
275 Modifies content descriptor to include _admin and insert create operation
276 :param content: descriptor to be modified
277 :param project_id: if included, it add project read/write permissions. Can be None or a list
278 :param make_public: if included it is generated as public for reading.
279 :return: op_id: operation id on asynchronous operation, None otherwise. In addition content is modified
281 super().format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
282 content
["schema_version"] = schema_version
= "1.11"
285 if content
.get(self
.password_to_encrypt
):
286 content
[self
.password_to_encrypt
] = self
.db
.encrypt(content
[self
.password_to_encrypt
],
287 schema_version
=schema_version
,
289 config_to_encrypt_keys
= self
.config_to_encrypt
.get(schema_version
) or self
.config_to_encrypt
.get("default")
290 if content
.get("config") and config_to_encrypt_keys
:
291 for p
in config_to_encrypt_keys
:
292 if content
["config"].get(p
):
293 content
["config"][p
] = self
.db
.encrypt(content
["config"][p
],
294 schema_version
=schema_version
,
297 content
["_admin"]["operationalState"] = "PROCESSING"
300 content
["_admin"]["operations"] = [self
._create
_operation
("create")]
301 content
["_admin"]["current_operation"] = None
303 return "{}:0".format(content
["_id"])
305 def delete(self
, session
, _id
, dry_run
=False):
307 Delete item by its internal _id
308 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
309 :param _id: server internal id
310 :param dry_run: make checking but do not delete
311 :return: operation id if it is ordered to delete. None otherwise
314 filter_q
= self
._get
_project
_filter
(session
)
315 filter_q
["_id"] = _id
316 db_content
= self
.db
.get_one(self
.topic
, filter_q
)
318 self
.check_conflict_on_del(session
, _id
, db_content
)
322 # remove reference from project_read. If not last delete
323 if session
["project_id"]:
324 for project_id
in session
["project_id"]:
325 if project_id
in db_content
["_admin"]["projects_read"]:
326 db_content
["_admin"]["projects_read"].remove(project_id
)
327 if project_id
in db_content
["_admin"]["projects_write"]:
328 db_content
["_admin"]["projects_write"].remove(project_id
)
330 db_content
["_admin"]["projects_read"].clear()
331 db_content
["_admin"]["projects_write"].clear()
333 update_dict
= {"_admin.projects_read": db_content
["_admin"]["projects_read"],
334 "_admin.projects_write": db_content
["_admin"]["projects_write"]
337 # check if there are projects referencing it (apart from ANY that means public)....
338 if db_content
["_admin"]["projects_read"] and (len(db_content
["_admin"]["projects_read"]) > 1 or
339 db_content
["_admin"]["projects_read"][0] != "ANY"):
340 self
.db
.set_one(self
.topic
, filter_q
, update_dict
=update_dict
) # remove references but not delete
345 self
.db
.del_one(self
.topic
, {"_id": _id
})
347 self
._send
_msg
("deleted", {"_id": _id
, "op_id": op_id
})
349 update_dict
["_admin.to_delete"] = True
350 self
.db
.set_one(self
.topic
, {"_id": _id
},
351 update_dict
=update_dict
,
352 push
={"_admin.operations": self
._create
_operation
("delete")}
354 # the number of operations is the operation_id. db_content does not contains the new operation inserted,
355 # so the -1 is not needed
356 op_id
= "{}:{}".format(db_content
["_id"], len(db_content
["_admin"]["operations"]))
357 self
._send
_msg
("delete", {"_id": _id
, "op_id": op_id
})
361 class VimAccountTopic(CommonVimWimSdn
):
362 topic
= "vim_accounts"
363 topic_msg
= "vim_account"
364 schema_new
= vim_account_new_schema
365 schema_edit
= vim_account_edit_schema
367 password_to_encrypt
= "vim_password"
368 config_to_encrypt
= {"1.1": ("admin_password", "nsx_password", "vcenter_password"),
369 "default": ("admin_password", "nsx_password", "vcenter_password", "vrops_password")}
372 class WimAccountTopic(CommonVimWimSdn
):
373 topic
= "wim_accounts"
374 topic_msg
= "wim_account"
375 schema_new
= wim_account_new_schema
376 schema_edit
= wim_account_edit_schema
378 password_to_encrypt
= "wim_password"
379 config_to_encrypt
= {}
382 class SdnTopic(CommonVimWimSdn
):
385 schema_new
= sdn_new_schema
386 schema_edit
= sdn_edit_schema
388 password_to_encrypt
= "password"
389 config_to_encrypt
= {}
392 class K8sClusterTopic(CommonVimWimSdn
):
393 topic
= "k8sclusters"
394 topic_msg
= "k8scluster"
395 schema_new
= k8scluster_new_schema
396 schema_edit
= k8scluster_edit_schema
398 password_to_encrypt
= None
399 config_to_encrypt
= {}
401 def format_on_new(self
, content
, project_id
=None, make_public
=False):
402 oid
= super().format_on_new(content
, project_id
, make_public
)
403 self
.db
.encrypt_decrypt_fields(content
["credentials"], 'encrypt', ['password', 'secret'],
404 schema_version
=content
["schema_version"], salt
=content
["_id"])
407 def format_on_edit(self
, final_content
, edit_content
):
408 if final_content
.get("schema_version") and edit_content
.get("credentials"):
409 self
.db
.encrypt_decrypt_fields(edit_content
["credentials"], 'encrypt', ['password', 'secret'],
410 schema_version
=final_content
["schema_version"], salt
=final_content
["_id"])
411 deep_update_rfc7396(final_content
["credentials"], edit_content
["credentials"])
412 oid
= super().format_on_edit(final_content
, edit_content
)
416 class K8sRepoTopic(CommonVimWimSdn
):
418 topic_msg
= "k8srepo"
419 schema_new
= k8srepo_new_schema
420 schema_edit
= k8srepo_edit_schema
422 password_to_encrypt
= None
423 config_to_encrypt
= {}
426 class UserTopicAuth(UserTopic
):
428 # topic_msg = "users"
429 schema_new
= user_new_schema
430 schema_edit
= user_edit_schema
432 def __init__(self
, db
, fs
, msg
, auth
):
433 UserTopic
.__init
__(self
, db
, fs
, msg
, auth
)
436 def check_conflict_on_new(self
, session
, indata
):
438 Check that the data to be inserted is valid
440 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
441 :param indata: data to be inserted
442 :return: None or raises EngineException
444 username
= indata
.get("username")
445 if is_valid_uuid(username
):
446 raise EngineException("username '{}' cannot have a uuid format".format(username
),
447 HTTPStatus
.UNPROCESSABLE_ENTITY
)
449 # Check that username is not used, regardless keystone already checks this
450 if self
.auth
.get_user_list(filter_q
={"name": username
}):
451 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
453 if "projects" in indata
.keys():
454 # convert to new format project_role_mappings
455 role
= self
.auth
.get_role_list({"name": "project_admin"})
457 role
= self
.auth
.get_role_list()
459 raise AuthconnNotFoundException("Can't find default role for user '{}'".format(username
))
461 if not indata
.get("project_role_mappings"):
462 indata
["project_role_mappings"] = []
463 for project
in indata
["projects"]:
464 pid
= self
.auth
.get_project(project
)["_id"]
465 prm
= {"project": pid
, "role": rid
}
466 if prm
not in indata
["project_role_mappings"]:
467 indata
["project_role_mappings"].append(prm
)
468 # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
469 # HTTPStatus.BAD_REQUEST)
471 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
473 Check that the data to be edited/uploaded is valid
475 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
476 :param final_content: data once modified
477 :param edit_content: incremental data that contains the modifications to apply
478 :param _id: internal _id
479 :return: None or raises EngineException
482 if "username" in edit_content
:
483 username
= edit_content
.get("username")
484 if is_valid_uuid(username
):
485 raise EngineException("username '{}' cannot have an uuid format".format(username
),
486 HTTPStatus
.UNPROCESSABLE_ENTITY
)
488 # Check that username is not used, regardless keystone already checks this
489 if self
.auth
.get_user_list(filter_q
={"name": username
}):
490 raise EngineException("username '{}' is already used".format(username
), HTTPStatus
.CONFLICT
)
492 if final_content
["username"] == "admin":
493 for mapping
in edit_content
.get("remove_project_role_mappings", ()):
494 if mapping
["project"] == "admin" and mapping
.get("role") in (None, "system_admin"):
495 # TODO make this also available for project id and role id
496 raise EngineException("You cannot remove system_admin role from admin user",
497 http_code
=HTTPStatus
.FORBIDDEN
)
499 def check_conflict_on_del(self
, session
, _id
, db_content
):
501 Check if deletion can be done because of dependencies if it is not force. To override
502 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
503 :param _id: internal _id
504 :param db_content: The database content of this item _id
505 :return: None if ok or raises EngineException with the conflict
507 if db_content
["username"] == session
["username"]:
508 raise EngineException("You cannot delete your own login user ", http_code
=HTTPStatus
.CONFLICT
)
509 # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
512 def format_on_show(content
):
514 Modifies the content of the role information to separate the role
515 metadata from the role definition.
517 project_role_mappings
= []
519 if "projects" in content
:
520 for project
in content
["projects"]:
521 for role
in project
["roles"]:
522 project_role_mappings
.append({"project": project
["_id"],
523 "project_name": project
["name"],
525 "role_name": role
["name"]})
526 del content
["projects"]
527 content
["project_role_mappings"] = project_role_mappings
531 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
533 Creates a new entry into the authentication backend.
535 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
537 :param rollback: list to append created items at database in case a rollback may to be done
538 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
539 :param indata: data to be inserted
540 :param kwargs: used to override the indata descriptor
541 :param headers: http request headers
542 :return: _id: identity of the inserted data, operation _id (None)
545 content
= BaseTopic
._remove
_envelop
(indata
)
547 # Override descriptor with query string kwargs
548 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
549 content
= self
._validate
_input
_new
(content
, session
["force"])
550 self
.check_conflict_on_new(session
, content
)
551 # self.format_on_new(content, session["project_id"], make_public=session["public"])
553 content
["_admin"] = {"created": now
, "modified": now
}
555 for prm
in content
.get("project_role_mappings", []):
556 proj
= self
.auth
.get_project(prm
["project"], not session
["force"])
557 role
= self
.auth
.get_role(prm
["role"], not session
["force"])
558 pid
= proj
["_id"] if proj
else None
559 rid
= role
["_id"] if role
else None
560 prl
= {"project": pid
, "role": rid
}
563 content
["project_role_mappings"] = prms
564 # _id = self.auth.create_user(content["username"], content["password"])["_id"]
565 _id
= self
.auth
.create_user(content
)["_id"]
567 rollback
.append({"topic": self
.topic
, "_id": _id
})
568 # del content["password"]
569 # self._send_msg("created", content)
571 except ValidationError
as e
:
572 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
574 def show(self
, session
, _id
):
576 Get complete information on an topic
578 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
579 :param _id: server internal id
580 :return: dictionary, raise exception if not found.
582 # Allow _id to be a name or uuid
583 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
584 # users = self.auth.get_user_list(filter_q)
585 users
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
589 raise EngineException("Too many users found", HTTPStatus
.CONFLICT
)
591 raise EngineException("User not found", HTTPStatus
.NOT_FOUND
)
593 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
595 Updates an user entry.
597 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
599 :param indata: data to be inserted
600 :param kwargs: used to override the indata descriptor
602 :return: _id: identity of the inserted data.
604 indata
= self
._remove
_envelop
(indata
)
606 # Override descriptor with query string kwargs
608 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
610 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
613 content
= self
.show(session
, _id
)
614 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
615 # self.format_on_edit(content, indata)
617 if not ("password" in indata
or "username" in indata
or indata
.get("remove_project_role_mappings") or
618 indata
.get("add_project_role_mappings") or indata
.get("project_role_mappings") or
619 indata
.get("projects") or indata
.get("add_projects")):
621 if indata
.get("project_role_mappings") \
622 and (indata
.get("remove_project_role_mappings") or indata
.get("add_project_role_mappings")):
623 raise EngineException("Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
624 "' or 'remove_project_role_mappings'", http_code
=HTTPStatus
.BAD_REQUEST
)
626 if indata
.get("projects") or indata
.get("add_projects"):
627 role
= self
.auth
.get_role_list({"name": "project_admin"})
629 role
= self
.auth
.get_role_list()
631 raise AuthconnNotFoundException("Can't find a default role for user '{}'"
632 .format(content
["username"]))
634 if "add_project_role_mappings" not in indata
:
635 indata
["add_project_role_mappings"] = []
636 if "remove_project_role_mappings" not in indata
:
637 indata
["remove_project_role_mappings"] = []
638 if isinstance(indata
.get("projects"), dict):
639 # backward compatible
640 for k
, v
in indata
["projects"].items():
641 if k
.startswith("$") and v
is None:
642 indata
["remove_project_role_mappings"].append({"project": k
[1:]})
643 elif k
.startswith("$+"):
644 indata
["add_project_role_mappings"].append({"project": v
, "role": rid
})
645 del indata
["projects"]
646 for proj
in indata
.get("projects", []) + indata
.get("add_projects", []):
647 indata
["add_project_role_mappings"].append({"project": proj
, "role": rid
})
649 # user = self.show(session, _id) # Already in 'content'
650 original_mapping
= content
["project_role_mappings"]
653 mappings_to_remove
= []
656 for to_remove
in indata
.get("remove_project_role_mappings", ()):
657 for mapping
in original_mapping
:
658 if to_remove
["project"] in (mapping
["project"], mapping
["project_name"]):
659 if not to_remove
.get("role") or to_remove
["role"] in (mapping
["role"], mapping
["role_name"]):
660 mappings_to_remove
.append(mapping
)
663 for to_add
in indata
.get("add_project_role_mappings", ()):
664 for mapping
in original_mapping
:
665 if to_add
["project"] in (mapping
["project"], mapping
["project_name"]) and \
666 to_add
["role"] in (mapping
["role"], mapping
["role_name"]):
668 if mapping
in mappings_to_remove
: # do not remove
669 mappings_to_remove
.remove(mapping
)
670 break # do not add, it is already at user
672 pid
= self
.auth
.get_project(to_add
["project"])["_id"]
673 rid
= self
.auth
.get_role(to_add
["role"])["_id"]
674 mappings_to_add
.append({"project": pid
, "role": rid
})
677 if indata
.get("project_role_mappings"):
678 for to_set
in indata
["project_role_mappings"]:
679 for mapping
in original_mapping
:
680 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
681 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
682 if mapping
in mappings_to_remove
: # do not remove
683 mappings_to_remove
.remove(mapping
)
684 break # do not add, it is already at user
686 pid
= self
.auth
.get_project(to_set
["project"])["_id"]
687 rid
= self
.auth
.get_role(to_set
["role"])["_id"]
688 mappings_to_add
.append({"project": pid
, "role": rid
})
689 for mapping
in original_mapping
:
690 for to_set
in indata
["project_role_mappings"]:
691 if to_set
["project"] in (mapping
["project"], mapping
["project_name"]) and \
692 to_set
["role"] in (mapping
["role"], mapping
["role_name"]):
696 if mapping
not in mappings_to_remove
: # do not remove
697 mappings_to_remove
.append(mapping
)
699 self
.auth
.update_user({"_id": _id
, "username": indata
.get("username"), "password": indata
.get("password"),
700 "add_project_role_mappings": mappings_to_add
,
701 "remove_project_role_mappings": mappings_to_remove
705 except ValidationError
as e
:
706 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
708 def list(self
, session
, filter_q
=None):
710 Get a list of the topic that matches a filter
711 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
712 :param filter_q: filter of data to be applied
713 :return: The list, it can be empty if no one match the filter.
715 user_list
= self
.auth
.get_user_list(filter_q
)
716 if not session
["allow_show_user_project_role"]:
717 # Bug 853 - Default filtering
718 user_list
= [usr
for usr
in user_list
if usr
["username"] == session
["username"]]
721 def delete(self
, session
, _id
, dry_run
=False):
723 Delete item by its internal _id
725 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
726 :param _id: server internal id
727 :param force: indicates if deletion must be forced in case of conflict
728 :param dry_run: make checking but do not delete
729 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
731 # Allow _id to be a name or uuid
732 user
= self
.auth
.get_user(_id
)
734 self
.check_conflict_on_del(session
, uid
, user
)
736 v
= self
.auth
.delete_user(uid
)
741 class ProjectTopicAuth(ProjectTopic
):
743 # topic_msg = "projects"
744 schema_new
= project_new_schema
745 schema_edit
= project_edit_schema
747 def __init__(self
, db
, fs
, msg
, auth
):
748 ProjectTopic
.__init
__(self
, db
, fs
, msg
, auth
)
751 def check_conflict_on_new(self
, session
, indata
):
753 Check that the data to be inserted is valid
755 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
756 :param indata: data to be inserted
757 :return: None or raises EngineException
759 project_name
= indata
.get("name")
760 if is_valid_uuid(project_name
):
761 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
762 HTTPStatus
.UNPROCESSABLE_ENTITY
)
764 project_list
= self
.auth
.get_project_list(filter_q
={"name": project_name
})
767 raise EngineException("project '{}' exists".format(project_name
), HTTPStatus
.CONFLICT
)
769 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
771 Check that the data to be edited/uploaded is valid
773 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
774 :param final_content: data once modified
775 :param edit_content: incremental data that contains the modifications to apply
776 :param _id: internal _id
777 :return: None or raises EngineException
780 project_name
= edit_content
.get("name")
781 if project_name
!= final_content
["name"]: # It is a true renaming
782 if is_valid_uuid(project_name
):
783 raise EngineException("project name '{}' cannot have an uuid format".format(project_name
),
784 HTTPStatus
.UNPROCESSABLE_ENTITY
)
786 if final_content
["name"] == "admin":
787 raise EngineException("You cannot rename project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
789 # Check that project name is not used, regardless keystone already checks this
790 if project_name
and self
.auth
.get_project_list(filter_q
={"name": project_name
}):
791 raise EngineException("project '{}' is already used".format(project_name
), HTTPStatus
.CONFLICT
)
793 def check_conflict_on_del(self
, session
, _id
, db_content
):
795 Check if deletion can be done because of dependencies if it is not force. To override
797 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
798 :param _id: internal _id
799 :param db_content: The database content of this item _id
800 :return: None if ok or raises EngineException with the conflict
803 def check_rw_projects(topic
, title
, id_field
):
804 for desc
in self
.db
.get_list(topic
):
805 if _id
in desc
["_admin"]["projects_read"] + desc
["_admin"]["projects_write"]:
806 raise EngineException("Project '{}' ({}) is being used by {} '{}'"
807 .format(db_content
["name"], _id
, title
, desc
[id_field
]), HTTPStatus
.CONFLICT
)
809 if _id
in session
["project_id"]:
810 raise EngineException("You cannot delete your own project", http_code
=HTTPStatus
.CONFLICT
)
812 if db_content
["name"] == "admin":
813 raise EngineException("You cannot delete project 'admin'", http_code
=HTTPStatus
.CONFLICT
)
815 # If any user is using this project, raise CONFLICT exception
816 if not session
["force"]:
817 for user
in self
.auth
.get_user_list():
818 for prm
in user
.get("project_role_mappings"):
819 if prm
["project"] == _id
:
820 raise EngineException("Project '{}' ({}) is being used by user '{}'"
821 .format(db_content
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
823 # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
824 if not session
["force"]:
825 check_rw_projects("vnfds", "VNF Descriptor", "id")
826 check_rw_projects("nsds", "NS Descriptor", "id")
827 check_rw_projects("nsts", "NS Template", "id")
828 check_rw_projects("pdus", "PDU Descriptor", "name")
830 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
832 Creates a new entry into the authentication backend.
834 NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
836 :param rollback: list to append created items at database in case a rollback may to be done
837 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
838 :param indata: data to be inserted
839 :param kwargs: used to override the indata descriptor
840 :param headers: http request headers
841 :return: _id: identity of the inserted data, operation _id (None)
844 content
= BaseTopic
._remove
_envelop
(indata
)
846 # Override descriptor with query string kwargs
847 BaseTopic
._update
_input
_with
_kwargs
(content
, kwargs
)
848 content
= self
._validate
_input
_new
(content
, session
["force"])
849 self
.check_conflict_on_new(session
, content
)
850 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
851 _id
= self
.auth
.create_project(content
)
852 rollback
.append({"topic": self
.topic
, "_id": _id
})
853 # self._send_msg("created", content)
855 except ValidationError
as e
:
856 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
858 def show(self
, session
, _id
):
860 Get complete information on an topic
862 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
863 :param _id: server internal id
864 :return: dictionary, raise exception if not found.
866 # Allow _id to be a name or uuid
867 filter_q
= {self
.id_field(self
.topic
, _id
): _id
}
868 # projects = self.auth.get_project_list(filter_q=filter_q)
869 projects
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
870 if len(projects
) == 1:
872 elif len(projects
) > 1:
873 raise EngineException("Too many projects found", HTTPStatus
.CONFLICT
)
875 raise EngineException("Project not found", HTTPStatus
.NOT_FOUND
)
877 def list(self
, session
, filter_q
=None):
879 Get a list of the topic that matches a filter
881 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
882 :param filter_q: filter of data to be applied
883 :return: The list, it can be empty if no one match the filter.
885 project_list
= self
.auth
.get_project_list(filter_q
)
886 if not session
["allow_show_user_project_role"]:
887 # Bug 853 - Default filtering
888 user
= self
.auth
.get_user(session
["username"])
889 projects
= [prm
["project"] for prm
in user
["project_role_mappings"]]
890 project_list
= [proj
for proj
in project_list
if proj
["_id"] in projects
]
893 def delete(self
, session
, _id
, dry_run
=False):
895 Delete item by its internal _id
897 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
898 :param _id: server internal id
899 :param dry_run: make checking but do not delete
900 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
902 # Allow _id to be a name or uuid
903 proj
= self
.auth
.get_project(_id
)
905 self
.check_conflict_on_del(session
, pid
, proj
)
907 v
= self
.auth
.delete_project(pid
)
911 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
913 Updates a project entry.
915 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
917 :param indata: data to be inserted
918 :param kwargs: used to override the indata descriptor
920 :return: _id: identity of the inserted data.
922 indata
= self
._remove
_envelop
(indata
)
924 # Override descriptor with query string kwargs
926 BaseTopic
._update
_input
_with
_kwargs
(indata
, kwargs
)
928 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
931 content
= self
.show(session
, _id
)
932 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
933 self
.format_on_edit(content
, indata
)
935 deep_update_rfc7396(content
, indata
)
936 self
.auth
.update_project(content
["_id"], content
)
937 except ValidationError
as e
:
938 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
941 class RoleTopicAuth(BaseTopic
):
943 topic_msg
= None # "roles"
944 schema_new
= roles_new_schema
945 schema_edit
= roles_edit_schema
948 def __init__(self
, db
, fs
, msg
, auth
, ops
):
949 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
951 self
.operations
= ops
952 # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
955 def validate_role_definition(operations
, role_definitions
):
957 Validates the role definition against the operations defined in
958 the resources to operations files.
960 :param operations: operations list
961 :param role_definitions: role definition to test
962 :return: None if ok, raises ValidationError exception on error
964 if not role_definitions
.get("permissions"):
966 ignore_fields
= ["admin", "default"]
967 for role_def
in role_definitions
["permissions"].keys():
968 if role_def
in ignore_fields
:
970 if role_def
[-1] == ":":
971 raise ValidationError("Operation cannot end with ':'")
973 role_def_matches
= [op
for op
in operations
if op
.startswith(role_def
)]
975 if len(role_def_matches
) == 0:
976 raise ValidationError("Invalid permission '{}'".format(role_def
))
978 def _validate_input_new(self
, input, force
=False):
980 Validates input user content for a new entry.
982 :param input: user input content for the new topic
983 :param force: may be used for being more tolerant
984 :return: The same input content, or a changed version of it.
987 validate_input(input, self
.schema_new
)
988 self
.validate_role_definition(self
.operations
, input)
992 def _validate_input_edit(self
, input, force
=False):
994 Validates input user content for updating an entry.
996 :param input: user input content for the new topic
997 :param force: may be used for being more tolerant
998 :return: The same input content, or a changed version of it.
1000 if self
.schema_edit
:
1001 validate_input(input, self
.schema_edit
)
1002 self
.validate_role_definition(self
.operations
, input)
1006 def check_conflict_on_new(self
, session
, indata
):
1008 Check that the data to be inserted is valid
1010 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1011 :param indata: data to be inserted
1012 :return: None or raises EngineException
1014 # check name is not uuid
1015 role_name
= indata
.get("name")
1016 if is_valid_uuid(role_name
):
1017 raise EngineException("role name '{}' cannot have an uuid format".format(role_name
),
1018 HTTPStatus
.UNPROCESSABLE_ENTITY
)
1019 # check name not exists
1020 name
= indata
["name"]
1021 # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
1022 if self
.auth
.get_role_list({"name": name
}):
1023 raise EngineException("role name '{}' exists".format(name
), HTTPStatus
.CONFLICT
)
1025 def check_conflict_on_edit(self
, session
, final_content
, edit_content
, _id
):
1027 Check that the data to be edited/uploaded is valid
1029 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1030 :param final_content: data once modified
1031 :param edit_content: incremental data that contains the modifications to apply
1032 :param _id: internal _id
1033 :return: None or raises EngineException
1035 if "default" not in final_content
["permissions"]:
1036 final_content
["permissions"]["default"] = False
1037 if "admin" not in final_content
["permissions"]:
1038 final_content
["permissions"]["admin"] = False
1040 # check name is not uuid
1041 role_name
= edit_content
.get("name")
1042 if is_valid_uuid(role_name
):
1043 raise EngineException("role name '{}' cannot have an uuid format".format(role_name
),
1044 HTTPStatus
.UNPROCESSABLE_ENTITY
)
1046 # Check renaming of admin roles
1047 role
= self
.auth
.get_role(_id
)
1048 if role
["name"] in ["system_admin", "project_admin"]:
1049 raise EngineException("You cannot rename role '{}'".format(role
["name"]), http_code
=HTTPStatus
.FORBIDDEN
)
1051 # check name not exists
1052 if "name" in edit_content
:
1053 role_name
= edit_content
["name"]
1054 # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
1055 roles
= self
.auth
.get_role_list({"name": role_name
})
1056 if roles
and roles
[0][BaseTopic
.id_field("roles", _id
)] != _id
:
1057 raise EngineException("role name '{}' exists".format(role_name
), HTTPStatus
.CONFLICT
)
1059 def check_conflict_on_del(self
, session
, _id
, db_content
):
1061 Check if deletion can be done because of dependencies if it is not force. To override
1063 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1064 :param _id: internal _id
1065 :param db_content: The database content of this item _id
1066 :return: None if ok or raises EngineException with the conflict
1068 role
= self
.auth
.get_role(_id
)
1069 if role
["name"] in ["system_admin", "project_admin"]:
1070 raise EngineException("You cannot delete role '{}'".format(role
["name"]), http_code
=HTTPStatus
.FORBIDDEN
)
1072 # If any user is using this role, raise CONFLICT exception
1073 for user
in self
.auth
.get_user_list():
1074 for prm
in user
.get("project_role_mappings"):
1075 if prm
["role"] == _id
:
1076 raise EngineException("Role '{}' ({}) is being used by user '{}'"
1077 .format(role
["name"], _id
, user
["username"]), HTTPStatus
.CONFLICT
)
1080 def format_on_new(content
, project_id
=None, make_public
=False): # TO BE REMOVED ?
1082 Modifies content descriptor to include _admin
1084 :param content: descriptor to be modified
1085 :param project_id: if included, it add project read/write permissions
1086 :param make_public: if included it is generated as public for reading.
1087 :return: None, but content is modified
1090 if "_admin" not in content
:
1091 content
["_admin"] = {}
1092 if not content
["_admin"].get("created"):
1093 content
["_admin"]["created"] = now
1094 content
["_admin"]["modified"] = now
1096 if "permissions" not in content
:
1097 content
["permissions"] = {}
1099 if "default" not in content
["permissions"]:
1100 content
["permissions"]["default"] = False
1101 if "admin" not in content
["permissions"]:
1102 content
["permissions"]["admin"] = False
1105 def format_on_edit(final_content
, edit_content
):
1107 Modifies final_content descriptor to include the modified date.
1109 :param final_content: final descriptor generated
1110 :param edit_content: alterations to be include
1111 :return: None, but final_content is modified
1113 if "_admin" in final_content
:
1114 final_content
["_admin"]["modified"] = time()
1116 if "permissions" not in final_content
:
1117 final_content
["permissions"] = {}
1119 if "default" not in final_content
["permissions"]:
1120 final_content
["permissions"]["default"] = False
1121 if "admin" not in final_content
["permissions"]:
1122 final_content
["permissions"]["admin"] = False
1125 def show(self
, session
, _id
):
1127 Get complete information on an topic
1129 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1130 :param _id: server internal id
1131 :return: dictionary, raise exception if not found.
1133 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1134 # roles = self.auth.get_role_list(filter_q)
1135 roles
= self
.list(session
, filter_q
) # To allow default filtering (Bug 853)
1137 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1138 elif len(roles
) > 1:
1139 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1142 def list(self
, session
, filter_q
=None):
1144 Get a list of the topic that matches a filter
1146 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1147 :param filter_q: filter of data to be applied
1148 :return: The list, it can be empty if no one match the filter.
1150 role_list
= self
.auth
.get_role_list(filter_q
)
1151 if not session
["allow_show_user_project_role"]:
1152 # Bug 853 - Default filtering
1153 user
= self
.auth
.get_user(session
["username"])
1154 roles
= [prm
["role"] for prm
in user
["project_role_mappings"]]
1155 role_list
= [role
for role
in role_list
if role
["_id"] in roles
]
1158 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1160 Creates a new entry into database.
1162 :param rollback: list to append created items at database in case a rollback may to be done
1163 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1164 :param indata: data to be inserted
1165 :param kwargs: used to override the indata descriptor
1166 :param headers: http request headers
1167 :return: _id: identity of the inserted data, operation _id (None)
1170 content
= self
._remove
_envelop
(indata
)
1172 # Override descriptor with query string kwargs
1173 self
._update
_input
_with
_kwargs
(content
, kwargs
)
1174 content
= self
._validate
_input
_new
(content
, session
["force"])
1175 self
.check_conflict_on_new(session
, content
)
1176 self
.format_on_new(content
, project_id
=session
["project_id"], make_public
=session
["public"])
1177 # role_name = content["name"]
1178 rid
= self
.auth
.create_role(content
)
1179 content
["_id"] = rid
1180 # _id = self.db.create(self.topic, content)
1181 rollback
.append({"topic": self
.topic
, "_id": rid
})
1182 # self._send_msg("created", content)
1184 except ValidationError
as e
:
1185 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1187 def delete(self
, session
, _id
, dry_run
=False):
1189 Delete item by its internal _id
1191 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1192 :param _id: server internal id
1193 :param dry_run: make checking but do not delete
1194 :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1196 filter_q
= {BaseTopic
.id_field(self
.topic
, _id
): _id
}
1197 roles
= self
.auth
.get_role_list(filter_q
)
1199 raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q
))
1200 elif len(roles
) > 1:
1201 raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q
))
1202 rid
= roles
[0]["_id"]
1203 self
.check_conflict_on_del(session
, rid
, None)
1204 # filter_q = {"_id": _id}
1205 # filter_q = {BaseTopic.id_field(self.topic, _id): _id} # To allow role addressing by name
1207 v
= self
.auth
.delete_role(rid
)
1208 # v = self.db.del_one(self.topic, filter_q)
1212 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1214 Updates a role entry.
1216 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1218 :param indata: data to be inserted
1219 :param kwargs: used to override the indata descriptor
1221 :return: _id: identity of the inserted data.
1224 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1226 indata
= self
._validate
_input
_edit
(indata
, force
=session
["force"])
1228 content
= self
.show(session
, _id
)
1229 deep_update_rfc7396(content
, indata
)
1230 self
.check_conflict_on_edit(session
, content
, indata
, _id
=_id
)
1231 self
.format_on_edit(content
, indata
)
1232 self
.auth
.update_role(content
)
1233 except ValidationError
as e
:
1234 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)