| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | |
| Eduardo Sousa | d795f87 | 2019-02-05 16:05:53 +0000 | [diff] [blame] | 3 | # Copyright 2018 Whitestack, LLC |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 6 | # not use this file except in compliance with the License. You may obtain |
| 7 | # a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 14 | # License for the specific language governing permissions and limitations |
| 15 | # under the License. |
| 16 | # |
| 17 | # For those usages not covered by the Apache License, Version 2.0 please |
| 18 | # contact: esousa@whitestack.com or glavado@whitestack.com |
| 19 | ## |
| 20 | |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 21 | """ |
| 22 | AuthconnKeystone implements implements the connector for |
| 23 | Openstack Keystone and leverages the RBAC model, to bring |
| 24 | it for OSM. |
| 25 | """ |
| Eduardo Sousa | 4460390 | 2019-06-04 08:10:32 +0100 | [diff] [blame] | 26 | |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 27 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 28 | __author__ = ( |
| 29 | "Eduardo Sousa <esousa@whitestack.com>, " |
| 30 | "Pedro de la Cruz Ramos <pdelacruzramos@altran.com>" |
| 31 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 32 | __date__ = "$27-jul-2018 23:59:59$" |
| 33 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 34 | from osm_nbi.authconn import ( |
| 35 | Authconn, |
| 36 | AuthException, |
| 37 | AuthconnOperationException, |
| 38 | AuthconnNotFoundException, |
| 39 | AuthconnConflictException, |
| 40 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 41 | |
| 42 | import logging |
| Eduardo Sousa | 29933fc | 2018-11-14 06:36:35 +0000 | [diff] [blame] | 43 | import requests |
| Eduardo Sousa | 4460390 | 2019-06-04 08:10:32 +0100 | [diff] [blame] | 44 | import time |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 45 | from keystoneauth1 import session |
| 46 | from keystoneauth1.identity import v3 |
| 47 | from keystoneauth1.exceptions.base import ClientException |
| Eduardo Sousa | 29933fc | 2018-11-14 06:36:35 +0000 | [diff] [blame] | 48 | from keystoneauth1.exceptions.http import Conflict |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 49 | from keystoneclient.v3 import client |
| 50 | from http import HTTPStatus |
| K Sai Kiran | 990ac46 | 2020-05-20 12:25:12 +0530 | [diff] [blame] | 51 | from osm_nbi.validation import is_valid_uuid, validate_input, http_schema |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 52 | |
| 53 | |
| 54 | class AuthconnKeystone(Authconn): |
| tierno | 9e87a7f | 2020-03-23 09:24:10 +0000 | [diff] [blame] | 55 | def __init__(self, config, db, role_permissions): |
| 56 | Authconn.__init__(self, config, db, role_permissions) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 57 | |
| 58 | self.logger = logging.getLogger("nbi.authenticator.keystone") |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 59 | self.domains_id2name = {} |
| 60 | self.domains_name2id = {} |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 61 | |
| K Sai Kiran | 990ac46 | 2020-05-20 12:25:12 +0530 | [diff] [blame] | 62 | self.auth_url = config.get("auth_url") |
| 63 | if config.get("auth_url"): |
| 64 | validate_input(self.auth_url, http_schema) |
| 65 | else: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 66 | self.auth_url = "http://{0}:{1}/v3".format( |
| 67 | config.get("auth_host", "keystone"), config.get("auth_port", "5000") |
| 68 | ) |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 69 | self.user_domain_name_list = config.get("user_domain_name", "default") |
| 70 | self.user_domain_name_list = self.user_domain_name_list.split(",") |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 71 | # read only domain list |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 72 | self.user_domain_ro_list = [ |
| 73 | x[:-3] for x in self.user_domain_name_list if x.endswith(":ro") |
| 74 | ] |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 75 | # remove the ":ro" |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 76 | self.user_domain_name_list = [ |
| 77 | x if not x.endswith(":ro") else x[:-3] for x in self.user_domain_name_list |
| 78 | ] |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 79 | |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 80 | self.admin_project = config.get("service_project", "service") |
| 81 | self.admin_username = config.get("service_username", "nbi") |
| 82 | self.admin_password = config.get("service_password", "nbi") |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 83 | self.project_domain_name_list = config.get("project_domain_name", "default") |
| 84 | self.project_domain_name_list = self.project_domain_name_list.split(",") |
| 85 | if len(self.user_domain_name_list) != len(self.project_domain_name_list): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 86 | raise ValueError( |
| 87 | "Invalid configuration parameter fo authenticate. 'project_domain_name' and " |
| 88 | "'user_domain_name' must be a comma-separated list with the same size. Revise " |
| 89 | "configuration or/and 'OSMNBI_AUTHENTICATION_PROJECT_DOMAIN_NAME', " |
| 90 | "'OSMNBI_AUTHENTICATION_USER_DOMAIN_NAME' Variables" |
| 91 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 92 | |
| Eduardo Sousa | 29933fc | 2018-11-14 06:36:35 +0000 | [diff] [blame] | 93 | # Waiting for Keystone to be up |
| 94 | available = None |
| 95 | counter = 300 |
| 96 | while available is None: |
| 97 | time.sleep(1) |
| 98 | try: |
| 99 | result = requests.get(self.auth_url) |
| 100 | available = True if result.status_code == 200 else None |
| 101 | except Exception: |
| 102 | counter -= 1 |
| 103 | if counter == 0: |
| 104 | raise AuthException("Keystone not available after 300s timeout") |
| 105 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 106 | self.auth = v3.Password( |
| 107 | user_domain_name=self.user_domain_name_list[0], |
| 108 | username=self.admin_username, |
| 109 | password=self.admin_password, |
| 110 | project_domain_name=self.project_domain_name_list[0], |
| 111 | project_name=self.admin_project, |
| 112 | auth_url=self.auth_url, |
| 113 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 114 | self.sess = session.Session(auth=self.auth) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 115 | self.keystone = client.Client( |
| 116 | session=self.sess, endpoint_override=self.auth_url |
| 117 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 118 | |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 119 | def authenticate(self, credentials, token_info=None): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 120 | """ |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 121 | Authenticate a user using username/password or token_info, plus project |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 122 | :param credentials: dictionary that contains: |
| 123 | username: name, id or None |
| 124 | password: password or None |
| 125 | project_id: name, id, or None. If None first found project will be used to get an scope token |
| 126 | project_domain_name: (Optional) To use a concrete domain for the project |
| 127 | user_domain_name: (Optional) To use a concrete domain for the project |
| 128 | other items are allowed and ignored |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 129 | :param token_info: previous token_info to obtain authorization |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 130 | :return: the scoped token info or raises an exception. The token is a dictionary with: |
| 131 | _id: token string id, |
| 132 | username: username, |
| 133 | project_id: scoped_token project_id, |
| 134 | project_name: scoped_token project_name, |
| 135 | expires: epoch time when it expires, |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 136 | |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 137 | """ |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 138 | username = None |
| 139 | user_id = None |
| 140 | project_id = None |
| 141 | project_name = None |
| 142 | if credentials.get("project_domain_name"): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 143 | project_domain_name_list = (credentials["project_domain_name"],) |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 144 | else: |
| 145 | project_domain_name_list = self.project_domain_name_list |
| 146 | if credentials.get("user_domain_name"): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 147 | user_domain_name_list = (credentials["user_domain_name"],) |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 148 | else: |
| 149 | user_domain_name_list = self.user_domain_name_list |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 150 | |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 151 | for index, project_domain_name in enumerate(project_domain_name_list): |
| 152 | user_domain_name = user_domain_name_list[index] |
| 153 | try: |
| 154 | if credentials.get("username"): |
| 155 | if is_valid_uuid(credentials["username"]): |
| 156 | user_id = credentials["username"] |
| 157 | else: |
| 158 | username = credentials["username"] |
| 159 | |
| 160 | # get an unscoped token firstly |
| 161 | unscoped_token = self.keystone.get_raw_token_from_identity_service( |
| 162 | auth_url=self.auth_url, |
| 163 | user_id=user_id, |
| 164 | username=username, |
| 165 | password=credentials.get("password"), |
| 166 | user_domain_name=user_domain_name, |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 167 | project_domain_name=project_domain_name, |
| 168 | ) |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 169 | elif token_info: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 170 | unscoped_token = self.keystone.tokens.validate( |
| 171 | token=token_info.get("_id") |
| 172 | ) |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 173 | else: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 174 | raise AuthException( |
| 175 | "Provide credentials: username/password or Authorization Bearer token", |
| 176 | http_code=HTTPStatus.UNAUTHORIZED, |
| 177 | ) |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 178 | |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 179 | if not credentials.get("project_id"): |
| 180 | # get first project for the user |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 181 | project_list = self.keystone.projects.list( |
| 182 | user=unscoped_token["user"]["id"] |
| 183 | ) |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 184 | if not project_list: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 185 | raise AuthException( |
| 186 | "The user {} has not any project and cannot be used for authentication".format( |
| 187 | credentials.get("username") |
| 188 | ), |
| 189 | http_code=HTTPStatus.UNAUTHORIZED, |
| 190 | ) |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 191 | project_id = project_list[0].id |
| 192 | else: |
| 193 | if is_valid_uuid(credentials["project_id"]): |
| 194 | project_id = credentials["project_id"] |
| 195 | else: |
| 196 | project_name = credentials["project_id"] |
| 197 | |
| 198 | scoped_token = self.keystone.get_raw_token_from_identity_service( |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 199 | auth_url=self.auth_url, |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 200 | project_name=project_name, |
| 201 | project_id=project_id, |
| 202 | user_domain_name=user_domain_name, |
| 203 | project_domain_name=project_domain_name, |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 204 | token=unscoped_token["auth_token"], |
| 205 | ) |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 206 | |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 207 | auth_token = { |
| 208 | "_id": scoped_token.auth_token, |
| 209 | "id": scoped_token.auth_token, |
| 210 | "user_id": scoped_token.user_id, |
| 211 | "username": scoped_token.username, |
| 212 | "project_id": scoped_token.project_id, |
| 213 | "project_name": scoped_token.project_name, |
| 214 | "project_domain_name": scoped_token.project_domain_name, |
| 215 | "user_domain_name": scoped_token.user_domain_name, |
| 216 | "expires": scoped_token.expires.timestamp(), |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 217 | "issued_at": scoped_token.issued.timestamp(), |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 218 | } |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 219 | |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 220 | return auth_token |
| 221 | except ClientException as e: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 222 | if ( |
| 223 | index >= len(user_domain_name_list) - 1 |
| 224 | or index >= len(project_domain_name_list) - 1 |
| 225 | ): |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 226 | # if last try, launch exception |
| 227 | # self.logger.exception("Error during user authentication using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 228 | raise AuthException( |
| 229 | "Error during user authentication using Keystone: {}".format(e), |
| 230 | http_code=HTTPStatus.UNAUTHORIZED, |
| 231 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 232 | |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 233 | def validate_token(self, token): |
| 234 | """ |
| 235 | Check if the token is valid. |
| 236 | |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 237 | :param token: token id to be validated |
| tierno | a6bb45d | 2019-06-14 09:45:39 +0000 | [diff] [blame] | 238 | :return: dictionary with information associated with the token: |
| 239 | "expires": |
| 240 | "_id": token_id, |
| 241 | "project_id": project_id, |
| 242 | "username": , |
| 243 | "roles": list with dict containing {name, id} |
| 244 | If the token is not valid an exception is raised. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 245 | """ |
| 246 | if not token: |
| 247 | return |
| 248 | |
| 249 | try: |
| 250 | token_info = self.keystone.tokens.validate(token=token) |
| tierno | a6bb45d | 2019-06-14 09:45:39 +0000 | [diff] [blame] | 251 | ses = { |
| 252 | "_id": token_info["auth_token"], |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 253 | "id": token_info["auth_token"], |
| tierno | a6bb45d | 2019-06-14 09:45:39 +0000 | [diff] [blame] | 254 | "project_id": token_info["project"]["id"], |
| 255 | "project_name": token_info["project"]["name"], |
| 256 | "user_id": token_info["user"]["id"], |
| 257 | "username": token_info["user"]["name"], |
| 258 | "roles": token_info["roles"], |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 259 | "expires": token_info.expires.timestamp(), |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 260 | "issued_at": token_info.issued.timestamp(), |
| tierno | a6bb45d | 2019-06-14 09:45:39 +0000 | [diff] [blame] | 261 | } |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 262 | |
| tierno | a6bb45d | 2019-06-14 09:45:39 +0000 | [diff] [blame] | 263 | return ses |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 264 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 265 | # self.logger.exception("Error during token validation using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 266 | raise AuthException( |
| 267 | "Error during token validation using Keystone: {}".format(e), |
| 268 | http_code=HTTPStatus.UNAUTHORIZED, |
| 269 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 270 | |
| 271 | def revoke_token(self, token): |
| 272 | """ |
| 273 | Invalidate a token. |
| 274 | |
| 275 | :param token: token to be revoked |
| 276 | """ |
| 277 | try: |
| Eduardo Sousa | 29933fc | 2018-11-14 06:36:35 +0000 | [diff] [blame] | 278 | self.logger.info("Revoking token: " + token) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 279 | self.keystone.tokens.revoke_token(token=token) |
| 280 | |
| 281 | return True |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 282 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 283 | # self.logger.exception("Error during token revocation using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 284 | raise AuthException( |
| 285 | "Error during token revocation using Keystone: {}".format(e), |
| 286 | http_code=HTTPStatus.UNAUTHORIZED, |
| 287 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 288 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 289 | def _get_domain_id(self, domain_name, fail_if_not_found=True): |
| 290 | """ |
| 291 | Get the domain id from the domain_name |
| 292 | :param domain_name: Can be the name or id |
| 293 | :param fail_if_not_found: If False it returns None instead of raising an exception if not found |
| 294 | :return: str or None/exception if domain is not found |
| 295 | """ |
| 296 | domain_id = self.domains_name2id.get(domain_name) |
| 297 | if not domain_id: |
| 298 | self._get_domains() |
| 299 | domain_id = self.domains_name2id.get(domain_name) |
| 300 | if not domain_id and domain_name in self.domains_id2name: |
| 301 | # domain_name is already an id |
| 302 | return domain_name |
| 303 | if not domain_id and fail_if_not_found: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 304 | raise AuthconnNotFoundException( |
| 305 | "Domain {} cannot be found".format(domain_name) |
| 306 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 307 | return domain_id |
| 308 | |
| 309 | def _get_domains(self): |
| 310 | """ |
| 311 | Obtain a dictionary with domain_id to domain_name, stored at self.domains_id2name |
| 312 | and from domain_name to domain_id, sored at self.domains_name2id |
| 313 | :return: None. Exceptions are ignored |
| 314 | """ |
| 315 | try: |
| 316 | domains = self.keystone.domains.list() |
| 317 | self.domains_id2name = {x.id: x.name for x in domains} |
| 318 | self.domains_name2id = {x.name: x.id for x in domains} |
| 319 | except Exception: |
| 320 | pass |
| 321 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 322 | def create_user(self, user_info): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 323 | """ |
| 324 | Create a user. |
| 325 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 326 | :param user_info: full user info. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 327 | :raises AuthconnOperationException: if user creation failed. |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 328 | :return: returns the id of the user in keystone. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 329 | """ |
| 330 | try: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 331 | if ( |
| 332 | user_info.get("domain_name") |
| 333 | and user_info["domain_name"] in self.user_domain_ro_list |
| 334 | ): |
| 335 | raise AuthconnConflictException( |
| 336 | "Cannot create a user in the read only domain {}".format( |
| 337 | user_info["domain_name"] |
| 338 | ) |
| 339 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 340 | |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 341 | new_user = self.keystone.users.create( |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 342 | user_info["username"], |
| 343 | password=user_info["password"], |
| 344 | domain=self._get_domain_id( |
| 345 | user_info.get("domain_name", self.user_domain_name_list[0]) |
| 346 | ), |
| 347 | _admin=user_info["_admin"], |
| 348 | ) |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 349 | if "project_role_mappings" in user_info.keys(): |
| 350 | for mapping in user_info["project_role_mappings"]: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 351 | self.assign_role_to_user( |
| 352 | new_user, mapping["project"], mapping["role"] |
| 353 | ) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 354 | return {"username": new_user.name, "_id": new_user.id} |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 355 | except Conflict as e: |
| 356 | # self.logger.exception("Error during user creation using keystone: {}".format(e)) |
| 357 | raise AuthconnOperationException(e, http_code=HTTPStatus.CONFLICT) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 358 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 359 | # self.logger.exception("Error during user creation using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 360 | raise AuthconnOperationException( |
| 361 | "Error during user creation using Keystone: {}".format(e) |
| 362 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 363 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 364 | def update_user(self, user_info): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 365 | """ |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 366 | Change the user name and/or password. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 367 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 368 | :param user_info: user info modifications |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 369 | :raises AuthconnOperationException: if change failed. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 370 | """ |
| 371 | try: |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 372 | user = user_info.get("_id") or user_info.get("username") |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 373 | try: |
| 374 | user_obj = self.keystone.users.get(user) |
| 375 | except Exception: |
| 376 | user_obj = None |
| 377 | if not user_obj: |
| 378 | for user_domain in self.user_domain_name_list: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 379 | domain_id = self._get_domain_id( |
| 380 | user_domain, fail_if_not_found=False |
| 381 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 382 | if not domain_id: |
| 383 | continue |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 384 | user_obj_list = self.keystone.users.list( |
| 385 | name=user, domain=domain_id |
| 386 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 387 | if user_obj_list: |
| 388 | user_obj = user_obj_list[0] |
| 389 | break |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 390 | else: # user not found |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 391 | raise AuthconnNotFoundException("User '{}' not found".format(user)) |
| 392 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 393 | user_id = user_obj.id |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 394 | domain_id = user_obj.domain_id |
| 395 | domain_name = self.domains_id2name.get(domain_id) |
| 396 | |
| 397 | if domain_name in self.user_domain_ro_list: |
| 398 | if user_info.get("password") or user_info.get("username"): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 399 | raise AuthconnConflictException( |
| 400 | "Cannot update the user {} belonging to a read only domain {}".format( |
| 401 | user, domain_name |
| 402 | ) |
| 403 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 404 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 405 | elif ( |
| 406 | user_info.get("password") |
| 407 | or user_info.get("username") |
| 408 | or user_info.get("add_project_role_mappings") |
| 409 | or user_info.get("remove_project_role_mappings") |
| 410 | ): |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 411 | # if user_index>0, it is an external domain, that should not be updated |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 412 | ctime = ( |
| 413 | user_obj._admin.get("created", 0) |
| 414 | if hasattr(user_obj, "_admin") |
| 415 | else 0 |
| 416 | ) |
| K Sai Kiran | 974276d | 2020-05-27 16:30:10 +0530 | [diff] [blame] | 417 | try: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 418 | self.keystone.users.update( |
| 419 | user_id, |
| 420 | password=user_info.get("password"), |
| 421 | name=user_info.get("username"), |
| 422 | _admin={"created": ctime, "modified": time.time()}, |
| 423 | ) |
| K Sai Kiran | 974276d | 2020-05-27 16:30:10 +0530 | [diff] [blame] | 424 | except Exception as e: |
| 425 | if user_info.get("username") or user_info.get("password"): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 426 | raise AuthconnOperationException( |
| 427 | "Error during username/password change: {}".format(str(e)) |
| 428 | ) |
| 429 | self.logger.error( |
| 430 | "Error during updating user profile: {}".format(str(e)) |
| 431 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 432 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 433 | for mapping in user_info.get("remove_project_role_mappings", []): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 434 | self.remove_role_from_user( |
| 435 | user_obj, mapping["project"], mapping["role"] |
| 436 | ) |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 437 | for mapping in user_info.get("add_project_role_mappings", []): |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 438 | self.assign_role_to_user(user_obj, mapping["project"], mapping["role"]) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 439 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 440 | # self.logger.exception("Error during user password/name update using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 441 | raise AuthconnOperationException( |
| 442 | "Error during user update using Keystone: {}".format(e) |
| 443 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 444 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 445 | def delete_user(self, user_id): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 446 | """ |
| 447 | Delete user. |
| 448 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 449 | :param user_id: user identifier. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 450 | :raises AuthconnOperationException: if user deletion failed. |
| 451 | """ |
| 452 | try: |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 453 | user_obj = self.keystone.users.get(user_id) |
| 454 | domain_id = user_obj.domain_id |
| 455 | domain_name = self.domains_id2name.get(domain_id) |
| 456 | if domain_name in self.user_domain_ro_list: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 457 | raise AuthconnConflictException( |
| 458 | "Cannot delete user {} belonging to a read only domain {}".format( |
| 459 | user_id, domain_name |
| 460 | ) |
| 461 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 462 | |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 463 | result, detail = self.keystone.users.delete(user_id) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 464 | if result.status_code != 204: |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 465 | raise ClientException("error {} {}".format(result.status_code, detail)) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 466 | return True |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 467 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 468 | # self.logger.exception("Error during user deletion using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 469 | raise AuthconnOperationException( |
| 470 | "Error during user deletion using Keystone: {}".format(e) |
| 471 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 472 | |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 473 | def get_user_list(self, filter_q=None): |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 474 | """ |
| 475 | Get user list. |
| 476 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 477 | :param filter_q: dictionary to filter user list by one or several |
| 478 | _id: |
| 479 | name (username is also admitted). If a user id is equal to the filter name, it is also provided |
| 480 | domain_id, domain_name |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 481 | :return: returns a list of users. |
| 482 | """ |
| 483 | try: |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 484 | self._get_domains() |
| 485 | filter_name = filter_domain = None |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 486 | if filter_q: |
| 487 | filter_name = filter_q.get("name") or filter_q.get("username") |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 488 | if filter_q.get("domain_name"): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 489 | filter_domain = self._get_domain_id( |
| 490 | filter_q["domain_name"], fail_if_not_found=False |
| 491 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 492 | # If domain is not found, use the same name to obtain an empty list |
| 493 | filter_domain = filter_domain or filter_q["domain_name"] |
| 494 | if filter_q.get("domain_id"): |
| 495 | filter_domain = filter_q["domain_id"] |
| 496 | |
| 497 | users = self.keystone.users.list(name=filter_name, domain=filter_domain) |
| 498 | # get users from user_domain_name_list[1:], because it will not be provided in case of LDAP |
| 499 | if filter_domain is None and len(self.user_domain_name_list) > 1: |
| 500 | for user_domain in self.user_domain_name_list[1:]: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 501 | domain_id = self._get_domain_id( |
| 502 | user_domain, fail_if_not_found=False |
| 503 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 504 | if not domain_id: |
| 505 | continue |
| 506 | # find if users of this domain are already provided. In this case ignore |
| 507 | for u in users: |
| 508 | if u.domain_id == domain_id: |
| 509 | break |
| 510 | else: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 511 | users += self.keystone.users.list( |
| 512 | name=filter_name, domain=domain_id |
| 513 | ) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 514 | |
| 515 | # if filter name matches a user id, provide it also |
| 516 | if filter_name: |
| 517 | try: |
| 518 | user_obj = self.keystone.users.get(filter_name) |
| 519 | if user_obj not in users: |
| 520 | users.append(user_obj) |
| 521 | except Exception: |
| 522 | pass |
| 523 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 524 | users = [ |
| 525 | { |
| 526 | "username": user.name, |
| 527 | "_id": user.id, |
| 528 | "id": user.id, |
| 529 | "_admin": user.to_dict().get("_admin", {}), # TODO: REVISE |
| 530 | "domain_name": self.domains_id2name.get(user.domain_id), |
| 531 | } |
| 532 | for user in users |
| 533 | if user.name != self.admin_username |
| 534 | ] |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 535 | |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 536 | if filter_q and filter_q.get("_id"): |
| 537 | users = [user for user in users if filter_q["_id"] == user["_id"]] |
| Eduardo Sousa | 2d5a515 | 2019-05-20 15:41:54 +0100 | [diff] [blame] | 538 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 539 | for user in users: |
| tierno | 1546f2a | 2019-08-20 15:38:11 +0000 | [diff] [blame] | 540 | user["project_role_mappings"] = [] |
| 541 | user["projects"] = [] |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 542 | projects = self.keystone.projects.list(user=user["_id"]) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 543 | for project in projects: |
| tierno | 1546f2a | 2019-08-20 15:38:11 +0000 | [diff] [blame] | 544 | user["projects"].append(project.name) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 545 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 546 | roles = self.keystone.roles.list( |
| 547 | user=user["_id"], project=project.id |
| 548 | ) |
| tierno | 1546f2a | 2019-08-20 15:38:11 +0000 | [diff] [blame] | 549 | for role in roles: |
| 550 | prm = { |
| 551 | "project": project.id, |
| 552 | "project_name": project.name, |
| 553 | "role_name": role.name, |
| 554 | "role": role.id, |
| 555 | } |
| 556 | user["project_role_mappings"].append(prm) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 557 | |
| 558 | return users |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 559 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 560 | # self.logger.exception("Error during user listing using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 561 | raise AuthconnOperationException( |
| 562 | "Error during user listing using Keystone: {}".format(e) |
| 563 | ) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 564 | |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 565 | def get_role_list(self, filter_q=None): |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 566 | """ |
| 567 | Get role list. |
| 568 | |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 569 | :param filter_q: dictionary to filter role list by _id and/or name. |
| Eduardo Sousa | 37de091 | 2019-05-23 02:17:22 +0100 | [diff] [blame] | 570 | :return: returns the list of roles. |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 571 | """ |
| 572 | try: |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 573 | filter_name = None |
| 574 | if filter_q: |
| 575 | filter_name = filter_q.get("name") |
| 576 | roles_list = self.keystone.roles.list(name=filter_name) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 577 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 578 | roles = [ |
| 579 | { |
| 580 | "name": role.name, |
| 581 | "_id": role.id, |
| 582 | "_admin": role.to_dict().get("_admin", {}), |
| 583 | "permissions": role.to_dict().get("permissions", {}), |
| 584 | } |
| 585 | for role in roles_list |
| 586 | if role.name != "service" |
| 587 | ] |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 588 | |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 589 | if filter_q and filter_q.get("_id"): |
| 590 | roles = [role for role in roles if filter_q["_id"] == role["_id"]] |
| 591 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 592 | return roles |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 593 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 594 | # self.logger.exception("Error during user role listing using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 595 | raise AuthException( |
| 596 | "Error during user role listing using Keystone: {}".format(e), |
| 597 | http_code=HTTPStatus.UNAUTHORIZED, |
| 598 | ) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 599 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 600 | def create_role(self, role_info): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 601 | """ |
| 602 | Create a role. |
| 603 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 604 | :param role_info: full role info. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 605 | :raises AuthconnOperationException: if role creation failed. |
| 606 | """ |
| 607 | try: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 608 | result = self.keystone.roles.create( |
| 609 | role_info["name"], |
| 610 | permissions=role_info.get("permissions"), |
| 611 | _admin=role_info.get("_admin"), |
| 612 | ) |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 613 | return result.id |
| Eduardo Sousa | 29933fc | 2018-11-14 06:36:35 +0000 | [diff] [blame] | 614 | except Conflict as ex: |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 615 | raise AuthconnConflictException(str(ex)) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 616 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 617 | # self.logger.exception("Error during role creation using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 618 | raise AuthconnOperationException( |
| 619 | "Error during role creation using Keystone: {}".format(e) |
| 620 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 621 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 622 | def delete_role(self, role_id): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 623 | """ |
| 624 | Delete a role. |
| 625 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 626 | :param role_id: role identifier. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 627 | :raises AuthconnOperationException: if role deletion failed. |
| 628 | """ |
| 629 | try: |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 630 | result, detail = self.keystone.roles.delete(role_id) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 631 | |
| 632 | if result.status_code != 204: |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 633 | raise ClientException("error {} {}".format(result.status_code, detail)) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 634 | |
| 635 | return True |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 636 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 637 | # self.logger.exception("Error during role deletion using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 638 | raise AuthconnOperationException( |
| 639 | "Error during role deletion using Keystone: {}".format(e) |
| 640 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 641 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 642 | def update_role(self, role_info): |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 643 | """ |
| 644 | Change the name of a role |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 645 | :param role_info: full role info |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 646 | :return: None |
| 647 | """ |
| 648 | try: |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 649 | rid = role_info["_id"] |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 650 | if not is_valid_uuid(rid): # Is this required? |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 651 | role_obj_list = self.keystone.roles.list(name=rid) |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 652 | if not role_obj_list: |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 653 | raise AuthconnNotFoundException("Role '{}' not found".format(rid)) |
| 654 | rid = role_obj_list[0].id |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 655 | self.keystone.roles.update( |
| 656 | rid, |
| 657 | name=role_info["name"], |
| 658 | permissions=role_info.get("permissions"), |
| 659 | _admin=role_info.get("_admin"), |
| 660 | ) |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 661 | except ClientException as e: |
| 662 | # self.logger.exception("Error during role update using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 663 | raise AuthconnOperationException( |
| 664 | "Error during role updating using Keystone: {}".format(e) |
| 665 | ) |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 666 | |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 667 | def get_project_list(self, filter_q=None): |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 668 | """ |
| 669 | Get all the projects. |
| 670 | |
| Eduardo Sousa | fa54cd9 | 2019-05-20 15:58:41 +0100 | [diff] [blame] | 671 | :param filter_q: dictionary to filter project list. |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 672 | :return: list of projects |
| 673 | """ |
| 674 | try: |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 675 | self._get_domains() |
| 676 | filter_name = filter_domain = None |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 677 | if filter_q: |
| 678 | filter_name = filter_q.get("name") |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 679 | if filter_q.get("domain_name"): |
| 680 | filter_domain = self.domains_name2id.get(filter_q["domain_name"]) |
| 681 | if filter_q.get("domain_id"): |
| 682 | filter_domain = filter_q["domain_id"] |
| 683 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 684 | projects = self.keystone.projects.list( |
| 685 | name=filter_name, domain=filter_domain |
| 686 | ) |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 687 | |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 688 | projects = [ |
| 689 | { |
| 690 | "name": project.name, |
| 691 | "_id": project.id, |
| 692 | "_admin": project.to_dict().get("_admin", {}), # TODO: REVISE |
| 693 | "quotas": project.to_dict().get("quotas", {}), # TODO: REVISE |
| 694 | "domain_name": self.domains_id2name.get(project.domain_id), |
| 695 | } |
| 696 | for project in projects |
| 697 | ] |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 698 | |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 699 | if filter_q and filter_q.get("_id"): |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 700 | projects = [ |
| 701 | project for project in projects if filter_q["_id"] == project["_id"] |
| 702 | ] |
| Eduardo Sousa | fa54cd9 | 2019-05-20 15:58:41 +0100 | [diff] [blame] | 703 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 704 | return projects |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 705 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 706 | # self.logger.exception("Error during user project listing using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 707 | raise AuthException( |
| 708 | "Error during user project listing using Keystone: {}".format(e), |
| 709 | http_code=HTTPStatus.UNAUTHORIZED, |
| 710 | ) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 711 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 712 | def create_project(self, project_info): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 713 | """ |
| 714 | Create a project. |
| 715 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 716 | :param project_info: full project info. |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 717 | :return: the internal id of the created project |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 718 | :raises AuthconnOperationException: if project creation failed. |
| 719 | """ |
| 720 | try: |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 721 | result = self.keystone.projects.create( |
| 722 | project_info["name"], |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 723 | domain=self._get_domain_id( |
| 724 | project_info.get("domain_name", self.project_domain_name_list[0]) |
| 725 | ), |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 726 | _admin=project_info["_admin"], |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 727 | quotas=project_info.get("quotas", {}), |
| tierno | 6486f74 | 2020-02-13 16:30:14 +0000 | [diff] [blame] | 728 | ) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 729 | return result.id |
| 730 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 731 | # self.logger.exception("Error during project creation using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 732 | raise AuthconnOperationException( |
| 733 | "Error during project creation using Keystone: {}".format(e) |
| 734 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 735 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 736 | def delete_project(self, project_id): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 737 | """ |
| 738 | Delete a project. |
| 739 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 740 | :param project_id: project identifier. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 741 | :raises AuthconnOperationException: if project deletion failed. |
| 742 | """ |
| 743 | try: |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 744 | # projects = self.keystone.projects.list() |
| 745 | # project_obj = [project for project in projects if project.id == project_id][0] |
| 746 | # result, _ = self.keystone.projects.delete(project_obj) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 747 | |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 748 | result, detail = self.keystone.projects.delete(project_id) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 749 | if result.status_code != 204: |
| tierno | 38dcfeb | 2019-06-10 16:44:00 +0000 | [diff] [blame] | 750 | raise ClientException("error {} {}".format(result.status_code, detail)) |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 751 | |
| 752 | return True |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 753 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 754 | # self.logger.exception("Error during project deletion using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 755 | raise AuthconnOperationException( |
| 756 | "Error during project deletion using Keystone: {}".format(e) |
| 757 | ) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 758 | |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 759 | def update_project(self, project_id, project_info): |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 760 | """ |
| 761 | Change the name of a project |
| 762 | :param project_id: project to be changed |
| delacruzramo | 01b15d3 | 2019-07-02 14:37:47 +0200 | [diff] [blame] | 763 | :param project_info: full project info |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 764 | :return: None |
| 765 | """ |
| 766 | try: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 767 | self.keystone.projects.update( |
| 768 | project_id, |
| 769 | name=project_info["name"], |
| 770 | _admin=project_info["_admin"], |
| 771 | quotas=project_info.get("quotas", {}), |
| 772 | ) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 773 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 774 | # self.logger.exception("Error during project update using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 775 | raise AuthconnOperationException( |
| 776 | "Error during project update using Keystone: {}".format(e) |
| 777 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 778 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 779 | def assign_role_to_user(self, user_obj, project, role): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 780 | """ |
| 781 | Assigning a role to a user in a project. |
| 782 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 783 | :param user_obj: user object, obtained with keystone.users.get or list. |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 784 | :param project: project name. |
| 785 | :param role: role name. |
| 786 | :raises AuthconnOperationException: if role assignment failed. |
| 787 | """ |
| 788 | try: |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 789 | try: |
| Eduardo Sousa | 4460390 | 2019-06-04 08:10:32 +0100 | [diff] [blame] | 790 | project_obj = self.keystone.projects.get(project) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 791 | except Exception: |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 792 | project_obj_list = self.keystone.projects.list(name=project) |
| 793 | if not project_obj_list: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 794 | raise AuthconnNotFoundException( |
| 795 | "Project '{}' not found".format(project) |
| 796 | ) |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 797 | project_obj = project_obj_list[0] |
| Eduardo Sousa | 4460390 | 2019-06-04 08:10:32 +0100 | [diff] [blame] | 798 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 799 | try: |
| Eduardo Sousa | 4460390 | 2019-06-04 08:10:32 +0100 | [diff] [blame] | 800 | role_obj = self.keystone.roles.get(role) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 801 | except Exception: |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 802 | role_obj_list = self.keystone.roles.list(name=role) |
| 803 | if not role_obj_list: |
| 804 | raise AuthconnNotFoundException("Role '{}' not found".format(role)) |
| 805 | role_obj = role_obj_list[0] |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 806 | |
| Eduardo Sousa | 29933fc | 2018-11-14 06:36:35 +0000 | [diff] [blame] | 807 | self.keystone.roles.grant(role_obj, user=user_obj, project=project_obj) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 808 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 809 | # self.logger.exception("Error during user role assignment using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 810 | raise AuthconnOperationException( |
| 811 | "Error during role '{}' assignment to user '{}' and project '{}' using " |
| 812 | "Keystone: {}".format(role, user_obj.name, project, e) |
| 813 | ) |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 814 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 815 | def remove_role_from_user(self, user_obj, project, role): |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 816 | """ |
| 817 | Remove a role from a user in a project. |
| 818 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 819 | :param user_obj: user object, obtained with keystone.users.get or list. |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 820 | :param project: project name or id. |
| 821 | :param role: role name or id. |
| 822 | |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 823 | :raises AuthconnOperationException: if role assignment revocation failed. |
| 824 | """ |
| 825 | try: |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 826 | try: |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 827 | project_obj = self.keystone.projects.get(project) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 828 | except Exception: |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 829 | project_obj_list = self.keystone.projects.list(name=project) |
| 830 | if not project_obj_list: |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 831 | raise AuthconnNotFoundException( |
| 832 | "Project '{}' not found".format(project) |
| 833 | ) |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 834 | project_obj = project_obj_list[0] |
| 835 | |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 836 | try: |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 837 | role_obj = self.keystone.roles.get(role) |
| tierno | ad6d533 | 2020-02-19 14:29:49 +0000 | [diff] [blame] | 838 | except Exception: |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 839 | role_obj_list = self.keystone.roles.list(name=role) |
| 840 | if not role_obj_list: |
| 841 | raise AuthconnNotFoundException("Role '{}' not found".format(role)) |
| 842 | role_obj = role_obj_list[0] |
| Eduardo Sousa | 819d34c | 2018-07-31 01:20:02 +0100 | [diff] [blame] | 843 | |
| Eduardo Sousa | 29933fc | 2018-11-14 06:36:35 +0000 | [diff] [blame] | 844 | self.keystone.roles.revoke(role_obj, user=user_obj, project=project_obj) |
| tierno | 4015b47 | 2019-06-10 13:57:29 +0000 | [diff] [blame] | 845 | except ClientException as e: |
| tierno | 701018c | 2019-06-25 11:13:14 +0000 | [diff] [blame] | 846 | # self.logger.exception("Error during user role revocation using keystone: {}".format(e)) |
| garciadeblas | 4568a37 | 2021-03-24 09:19:48 +0100 | [diff] [blame] | 847 | raise AuthconnOperationException( |
| 848 | "Error during role '{}' revocation to user '{}' and project '{}' using " |
| 849 | "Keystone: {}".format(role, user_obj.name, project, e) |
| 850 | ) |