X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FNBI.git;a=blobdiff_plain;f=osm_nbi%2Fauthconn_keystone.py;h=9f5e02c2efcd4e662f7ba42d0ebcb43bce9b41f8;hp=ff5413066f8ef0b5ce07bcdc30aa3cb4732071c2;hb=d77ba6fb46f75d52475978e6e1272b2169edd56c;hpb=38dcfeb4a5d8c8da65b9ee2d2c2f58bc6164f6bf diff --git a/osm_nbi/authconn_keystone.py b/osm_nbi/authconn_keystone.py index ff54130..9f5e02c 100644 --- a/osm_nbi/authconn_keystone.py +++ b/osm_nbi/authconn_keystone.py @@ -28,7 +28,8 @@ it for OSM. __author__ = "Eduardo Sousa " __date__ = "$27-jul-2018 23:59:59$" -from authconn import Authconn, AuthException, AuthconnOperationException +from authconn import Authconn, AuthException, AuthconnOperationException, AuthconnNotFoundException, \ + AuthconnConflictException import logging import requests @@ -77,13 +78,13 @@ class AuthconnKeystone(Authconn): self.sess = session.Session(auth=self.auth) self.keystone = client.Client(session=self.sess) - def authenticate(self, user, password, project=None, token=None): + def authenticate(self, user, password, project=None, token_info=None): """ - Authenticate a user using username/password or token, plus project + Authenticate a user using username/password or token_info, plus project :param user: user: name, id or None :param password: password or None :param project: name, id, or None. If None first found project will be used to get an scope token - :param token: previous token to obtain authorization + :param token_info: previous token_info to obtain authorization :return: the scoped token info or raises an exception. The token is a dictionary with: _id: token string id, username: username, @@ -112,8 +113,8 @@ class AuthconnKeystone(Authconn): password=password, user_domain_name=self.user_domain_name, project_domain_name=self.project_domain_name) - elif token: - unscoped_token = self.keystone.tokens.validate(token=token) + elif token_info: + unscoped_token = self.keystone.tokens.validate(token=token_info.get("_id")) else: raise AuthException("Provide credentials: username/password or Authorization Bearer token", http_code=HTTPStatus.UNAUTHORIZED) @@ -141,15 +142,18 @@ class AuthconnKeystone(Authconn): auth_token = { "_id": scoped_token.auth_token, + "id": scoped_token.auth_token, + "user_id": scoped_token.user_id, "username": scoped_token.username, "project_id": scoped_token.project_id, "project_name": scoped_token.project_name, "expires": scoped_token.expires.timestamp(), + "issued_at": scoped_token.issued.timestamp() } return auth_token except ClientException as e: - self.logger.exception("Error during user authentication using keystone. Method: basic: {}".format(e)) + # self.logger.exception("Error during user authentication using keystone. Method: basic: {}".format(e)) raise AuthException("Error during user authentication using Keystone: {}".format(e), http_code=HTTPStatus.UNAUTHORIZED) @@ -178,7 +182,7 @@ class AuthconnKeystone(Authconn): # # return new_token["auth_token"], project_names # except ClientException as e: - # self.logger.exception("Error during user authentication using keystone. Method: bearer: {}".format(e)) + # # self.logger.exception("Error during user authentication using keystone. Method: bearer: {}".format(e)) # raise AuthException("Error during user authentication using Keystone: {}".format(e), # http_code=HTTPStatus.UNAUTHORIZED) @@ -186,19 +190,35 @@ class AuthconnKeystone(Authconn): """ Check if the token is valid. - :param token: token to validate - :return: dictionary with information associated with the token. If the - token is not valid, returns None. + :param token: token id to be validated + :return: dictionary with information associated with the token: + "expires": + "_id": token_id, + "project_id": project_id, + "username": , + "roles": list with dict containing {name, id} + If the token is not valid an exception is raised. """ if not token: return try: token_info = self.keystone.tokens.validate(token=token) + ses = { + "_id": token_info["auth_token"], + "id": token_info["auth_token"], + "project_id": token_info["project"]["id"], + "project_name": token_info["project"]["name"], + "user_id": token_info["user"]["id"], + "username": token_info["user"]["name"], + "roles": token_info["roles"], + "expires": token_info.expires.timestamp(), + "issued_at": token_info.issued.timestamp() + } - return token_info + return ses except ClientException as e: - self.logger.exception("Error during token validation using keystone: {}".format(e)) + # self.logger.exception("Error during token validation using keystone: {}".format(e)) raise AuthException("Error during token validation using Keystone: {}".format(e), http_code=HTTPStatus.UNAUTHORIZED) @@ -214,7 +234,7 @@ class AuthconnKeystone(Authconn): return True except ClientException as e: - self.logger.exception("Error during token revocation using keystone: {}".format(e)) + # self.logger.exception("Error during token revocation using keystone: {}".format(e)) raise AuthException("Error during token revocation using Keystone: {}".format(e), http_code=HTTPStatus.UNAUTHORIZED) @@ -232,7 +252,7 @@ class AuthconnKeystone(Authconn): return project_names except ClientException as e: - self.logger.exception("Error during user project listing using keystone: {}".format(e)) + # self.logger.exception("Error during user project listing using keystone: {}".format(e)) raise AuthException("Error during user project listing using Keystone: {}".format(e), http_code=HTTPStatus.UNAUTHORIZED) @@ -252,7 +272,7 @@ class AuthconnKeystone(Authconn): return roles except ClientException as e: - self.logger.exception("Error during user role listing using keystone: {}".format(e)) + # self.logger.exception("Error during user role listing using keystone: {}".format(e)) raise AuthException("Error during user role listing using Keystone: {}".format(e), http_code=HTTPStatus.UNAUTHORIZED) @@ -268,24 +288,35 @@ class AuthconnKeystone(Authconn): try: new_user = self.keystone.users.create(user, password=password, domain=self.user_domain_name) return {"username": new_user.name, "_id": new_user.id} + except Conflict as e: + # self.logger.exception("Error during user creation using keystone: {}".format(e)) + raise AuthconnOperationException(e, http_code=HTTPStatus.CONFLICT) except ClientException as e: - self.logger.exception("Error during user creation using keystone: {}".format(e)) + # self.logger.exception("Error during user creation using keystone: {}".format(e)) raise AuthconnOperationException("Error during user creation using Keystone: {}".format(e)) - def change_password(self, user, new_password): + def update_user(self, user, new_name=None, new_password=None): """ - Change the user password. + Change the user name and/or password. - :param user: username. + :param user: username or user_id + :param new_name: new name :param new_password: new password. - :raises AuthconnOperationException: if user password change failed. + :raises AuthconnOperationException: if change failed. """ try: - user_obj = list(filter(lambda x: x.name == user, self.keystone.users.list()))[0] - self.keystone.users.update(user_obj, password=new_password) + if is_valid_uuid(user): + user_id = user + else: + user_obj_list = self.keystone.users.list(name=user) + if not user_obj_list: + raise AuthconnNotFoundException("User '{}' not found".format(user)) + user_id = user_obj_list[0].id + + self.keystone.users.update(user_id, password=new_password, name=new_name) except ClientException as e: - self.logger.exception("Error during user password update using keystone: {}".format(e)) - raise AuthconnOperationException("Error during user password update using Keystone: {}".format(e)) + # self.logger.exception("Error during user password/name update using keystone: {}".format(e)) + raise AuthconnOperationException("Error during user password/name update using Keystone: {}".format(e)) def delete_user(self, user_id): """ @@ -305,31 +336,29 @@ class AuthconnKeystone(Authconn): return True except ClientException as e: - self.logger.exception("Error during user deletion using keystone: {}".format(e)) + # self.logger.exception("Error during user deletion using keystone: {}".format(e)) raise AuthconnOperationException("Error during user deletion using Keystone: {}".format(e)) - def get_user_list(self, filter_q={}): + def get_user_list(self, filter_q=None): """ Get user list. - :param filter_q: dictionary to filter user list. + :param filter_q: dictionary to filter user list by name (username is also admited) and/or _id :return: returns a list of users. """ try: - users = self.keystone.users.list() + filter_name = None + if filter_q: + filter_name = filter_q.get("name") or filter_q.get("username") + users = self.keystone.users.list(name=filter_name) users = [{ "username": user.name, "_id": user.id, "id": user.id } for user in users if user.name != self.admin_username] - allowed_fields = ["_id", "id", "username"] - for key in filter_q.keys(): - if key not in allowed_fields: - continue - - users = [user for user in users - if filter_q[key] == user[key]] + if filter_q and filter_q.get("_id"): + users = [user for user in users if filter_q["_id"] == user["_id"]] for user in users: projects = self.keystone.projects.list(user=user["_id"]) @@ -352,26 +381,33 @@ class AuthconnKeystone(Authconn): return users except ClientException as e: - self.logger.exception("Error during user listing using keystone: {}".format(e)) + # self.logger.exception("Error during user listing using keystone: {}".format(e)) raise AuthconnOperationException("Error during user listing using Keystone: {}".format(e)) - def get_role_list(self): + def get_role_list(self, filter_q=None): """ Get role list. + :param filter_q: dictionary to filter role list by _id and/or name. :return: returns the list of roles. """ try: - roles_list = self.keystone.roles.list() + filter_name = None + if filter_q: + filter_name = filter_q.get("name") + roles_list = self.keystone.roles.list(name=filter_name) roles = [{ "name": role.name, "_id": role.id } for role in roles_list if role.name != "service"] + if filter_q and filter_q.get("_id"): + roles = [role for role in roles if filter_q["_id"] == role["_id"]] + return roles except ClientException as e: - self.logger.exception("Error during user role listing using keystone: {}".format(e)) + # self.logger.exception("Error during user role listing using keystone: {}".format(e)) raise AuthException("Error during user role listing using Keystone: {}".format(e), http_code=HTTPStatus.UNAUTHORIZED) @@ -384,11 +420,11 @@ class AuthconnKeystone(Authconn): """ try: result = self.keystone.roles.create(role) - return {"name": result.name, "_id": result.id} + return result.id except Conflict as ex: - self.logger.info("Duplicate entry: %s", str(ex)) + raise AuthconnConflictException(str(ex)) except ClientException as e: - self.logger.exception("Error during role creation using keystone: {}".format(e)) + # self.logger.exception("Error during role creation using keystone: {}".format(e)) raise AuthconnOperationException("Error during role creation using Keystone: {}".format(e)) def delete_role(self, role_id): @@ -399,18 +435,36 @@ class AuthconnKeystone(Authconn): :raises AuthconnOperationException: if role deletion failed. """ try: - roles = self.keystone.roles.list() - role_obj = [role for role in roles if role.id == role_id][0] - result, detail = self.keystone.roles.delete(role_obj) + result, detail = self.keystone.roles.delete(role_id) if result.status_code != 204: raise ClientException("error {} {}".format(result.status_code, detail)) return True except ClientException as e: - self.logger.exception("Error during role deletion using keystone: {}".format(e)) + # self.logger.exception("Error during role deletion using keystone: {}".format(e)) raise AuthconnOperationException("Error during role deletion using Keystone: {}".format(e)) + def update_role(self, role, new_name): + """ + Change the name of a role + :param role: role name or id to be changed + :param new_name: new name + :return: None + """ + try: + if is_valid_uuid(role): + role_id = role + else: + role_obj_list = self.keystone.roles.list(name=role) + if not role_obj_list: + raise AuthconnNotFoundException("Role '{}' not found".format(role)) + role_id = role_obj_list[0].id + self.keystone.roles.update(role_id, name=new_name) + except ClientException as e: + # self.logger.exception("Error during role update using keystone: {}".format(e)) + raise AuthconnOperationException("Error during role updating using Keystone: {}".format(e)) + def get_project_list(self, filter_q=None): """ Get all the projects. @@ -435,7 +489,7 @@ class AuthconnKeystone(Authconn): return projects except ClientException as e: - self.logger.exception("Error during user project listing using keystone: {}".format(e)) + # self.logger.exception("Error during user project listing using keystone: {}".format(e)) raise AuthException("Error during user project listing using Keystone: {}".format(e), http_code=HTTPStatus.UNAUTHORIZED) @@ -451,7 +505,7 @@ class AuthconnKeystone(Authconn): result = self.keystone.projects.create(project, self.project_domain_name) return result.id except ClientException as e: - self.logger.exception("Error during project creation using keystone: {}".format(e)) + # self.logger.exception("Error during project creation using keystone: {}".format(e)) raise AuthconnOperationException("Error during project creation using Keystone: {}".format(e)) def delete_project(self, project_id): @@ -472,7 +526,7 @@ class AuthconnKeystone(Authconn): return True except ClientException as e: - self.logger.exception("Error during project deletion using keystone: {}".format(e)) + # self.logger.exception("Error during project deletion using keystone: {}".format(e)) raise AuthconnOperationException("Error during project deletion using Keystone: {}".format(e)) def update_project(self, project_id, new_name): @@ -485,7 +539,7 @@ class AuthconnKeystone(Authconn): try: self.keystone.projects.update(project_id, name=new_name) except ClientException as e: - self.logger.exception("Error during project update using keystone: {}".format(e)) + # self.logger.exception("Error during project update using keystone: {}".format(e)) raise AuthconnOperationException("Error during project deletion using Keystone: {}".format(e)) def assign_role_to_user(self, user, project, role): @@ -501,38 +555,70 @@ class AuthconnKeystone(Authconn): if is_valid_uuid(user): user_obj = self.keystone.users.get(user) else: - user_obj = self.keystone.users.list(name=user)[0] + user_obj_list = self.keystone.users.list(name=user) + if not user_obj_list: + raise AuthconnNotFoundException("User '{}' not found".format(user)) + user_obj = user_obj_list[0] if is_valid_uuid(project): project_obj = self.keystone.projects.get(project) else: - project_obj = self.keystone.projects.list(name=project)[0] + project_obj_list = self.keystone.projects.list(name=project) + if not project_obj_list: + raise AuthconnNotFoundException("Project '{}' not found".format(project)) + project_obj = project_obj_list[0] if is_valid_uuid(role): role_obj = self.keystone.roles.get(role) else: - role_obj = self.keystone.roles.list(name=role)[0] + role_obj_list = self.keystone.roles.list(name=role) + if not role_obj_list: + raise AuthconnNotFoundException("Role '{}' not found".format(role)) + role_obj = role_obj_list[0] self.keystone.roles.grant(role_obj, user=user_obj, project=project_obj) except ClientException as e: - self.logger.exception("Error during user role assignment using keystone: {}".format(e)) - raise AuthconnOperationException("Error during user role assignment using Keystone: {}".format(e)) + # self.logger.exception("Error during user role assignment using keystone: {}".format(e)) + raise AuthconnOperationException("Error during role '{}' assignment to user '{}' and project '{}' using " + "Keystone: {}".format(role, user, project, e)) def remove_role_from_user(self, user, project, role): """ Remove a role from a user in a project. :param user: username. - :param project: project name. - :param role: role name. + :param project: project name or id. + :param role: role name or id. + :raises AuthconnOperationException: if role assignment revocation failed. """ try: - user_obj = list(filter(lambda x: x.name == user, self.keystone.users.list()))[0] - project_obj = list(filter(lambda x: x.name == project, self.keystone.projects.list()))[0] - role_obj = list(filter(lambda x: x.name == role, self.keystone.roles.list()))[0] + if is_valid_uuid(user): + user_obj = self.keystone.users.get(user) + else: + user_obj_list = self.keystone.users.list(name=user) + if not user_obj_list: + raise AuthconnNotFoundException("User '{}' not found".format(user)) + user_obj = user_obj_list[0] + + if is_valid_uuid(project): + project_obj = self.keystone.projects.get(project) + else: + project_obj_list = self.keystone.projects.list(name=project) + if not project_obj_list: + raise AuthconnNotFoundException("Project '{}' not found".format(project)) + project_obj = project_obj_list[0] + + if is_valid_uuid(role): + role_obj = self.keystone.roles.get(role) + else: + role_obj_list = self.keystone.roles.list(name=role) + if not role_obj_list: + raise AuthconnNotFoundException("Role '{}' not found".format(role)) + role_obj = role_obj_list[0] self.keystone.roles.revoke(role_obj, user=user_obj, project=project_obj) except ClientException as e: - self.logger.exception("Error during user role revocation using keystone: {}".format(e)) - raise AuthconnOperationException("Error during user role revocation using Keystone: {}".format(e)) + # self.logger.exception("Error during user role revocation using keystone: {}".format(e)) + raise AuthconnOperationException("Error during role '{}' revocation to user '{}' and project '{}' using " + "Keystone: {}".format(role, user, project, e))