1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
|
# Copyright 2018 SUSE Linux GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
"""Identity v3 Application Credential action implementations"""
import datetime
import json
import logging
import uuid
from cliff import columns as cliff_columns
from osc_lib.command import command
from osc_lib import exceptions
from osc_lib import utils
from openstackclient.i18n import _
from openstackclient.identity import common
LOG = logging.getLogger(__name__)
class RolesColumn(cliff_columns.FormattableColumn):
"""Generate a formatted string of role names."""
def human_readable(self):
return utils.format_list(r['name'] for r in self._value)
def _format_application_credential(
application_credential, *, include_secret=False
):
column_headers: tuple[str, ...] = (
'ID',
'Name',
'Description',
'Project ID',
'Roles',
'Unrestricted',
'Access Rules',
'Expires At',
)
columns: tuple[str, ...] = (
'id',
'name',
'description',
'project_id',
'roles',
'unrestricted',
'access_rules',
'expires_at',
)
if include_secret:
column_headers += ('Secret',)
columns += ('secret',)
return (
column_headers,
utils.get_item_properties(
application_credential, columns, formatters={'roles': RolesColumn}
),
)
def _format_application_credentials(application_credentials):
column_headers = (
'ID',
'Name',
'Description',
'Project ID',
'Roles',
'Unrestricted',
'Access Rules',
'Expires At',
)
columns = (
'id',
'name',
'description',
'project_id',
'roles',
'unrestricted',
'access_rules',
'expires_at',
)
return (
column_headers,
(
utils.get_item_properties(
x, columns, formatters={'roles': RolesColumn}
)
for x in application_credentials
),
)
# TODO(stephenfin): Move this to osc_lib since it's useful elsewhere
def is_uuid_like(value) -> bool:
"""Returns validation of a value as a UUID.
:param val: Value to verify
:type val: string
:returns: bool
"""
try:
formatted_value = (
value.replace('urn:', '')
.replace('uuid:', '')
.strip('{}')
.replace('-', '')
.lower()
)
return str(uuid.UUID(value)).replace('-', '') == formatted_value
except (TypeError, ValueError, AttributeError):
return False
class CreateApplicationCredential(command.ShowOne):
_description = _("Create new application credential")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'name',
metavar='<name>',
help=_('Name of the application credential'),
)
parser.add_argument(
'--secret',
metavar='<secret>',
help=_(
'Secret to use for authentication (if not provided, one'
' will be generated)'
),
)
parser.add_argument(
'--role',
metavar='<role>',
action='append',
default=[],
help=_(
'Roles to authorize (name or ID) (repeat option to set'
' multiple values)'
),
)
parser.add_argument(
'--expiration',
metavar='<expiration>',
help=_(
'Sets an expiration date for the application credential,'
' format of YYYY-mm-ddTHH:MM:SS (if not provided, the'
' application credential will not expire)'
),
)
parser.add_argument(
'--description',
metavar='<description>',
help=_('Application credential description'),
)
parser.add_argument(
'--unrestricted',
action="store_true",
help=_(
'Enable application credential to create and delete other'
' application credentials and trusts (this is potentially'
' dangerous behavior and is disabled by default)'
),
)
parser.add_argument(
'--restricted',
action="store_true",
help=_(
'Prohibit application credential from creating and deleting'
' other application credentials and trusts (this is the'
' default behavior)'
),
)
parser.add_argument(
'--access-rules',
metavar='<access-rules>',
help=_(
'Either a string or file path containing a JSON-formatted '
'list of access rules, each containing a request method, '
'path, and service, for example '
'\'[{"method": "GET", '
'"path": "/v2.1/servers", '
'"service": "compute"}]\''
),
)
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.sdk_connection.identity
conn = self.app.client_manager.sdk_connection
user_id = conn.config.get_auth().get_user_id(conn.identity)
role_ids = []
for role in parsed_args.role:
if is_uuid_like(role):
role_ids.append({'id': role})
else:
role_ids.append({'name': role})
expires_at = None
if parsed_args.expiration:
expires_at = datetime.datetime.strptime(
parsed_args.expiration, '%Y-%m-%dT%H:%M:%S'
)
if parsed_args.restricted:
unrestricted = False
else:
unrestricted = parsed_args.unrestricted
if parsed_args.access_rules:
try:
access_rules = json.loads(parsed_args.access_rules)
except ValueError:
try:
with open(parsed_args.access_rules) as f:
access_rules = json.load(f)
except OSError:
msg = _(
"Access rules is not valid JSON string or file does"
" not exist."
)
raise exceptions.CommandError(msg)
else:
access_rules = []
application_credential = identity_client.create_application_credential(
user_id,
parsed_args.name,
roles=role_ids,
expires_at=expires_at,
description=parsed_args.description,
secret=parsed_args.secret,
unrestricted=unrestricted,
access_rules=access_rules,
)
return _format_application_credential(
application_credential, include_secret=True
)
class DeleteApplicationCredential(command.Command):
_description = _("Delete application credentials(s)")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'application_credential',
metavar='<application-credential>',
nargs="+",
help=_('Application credentials(s) to delete (name or ID)'),
)
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.sdk_connection.identity
conn = self.app.client_manager.sdk_connection
user_id = conn.config.get_auth().get_user_id(conn.identity)
errors = 0
for ac in parsed_args.application_credential:
try:
app_cred = identity_client.find_application_credential(
user_id, ac
)
identity_client.delete_application_credential(
user_id, app_cred.id
)
except Exception as e:
errors += 1
LOG.error(
_(
"Failed to delete application credential with "
"name or ID '%(ac)s': %(e)s"
),
{'ac': ac, 'e': e},
)
if errors > 0:
total = len(parsed_args.application_credential)
msg = _(
"%(errors)s of %(total)s application credentials failed "
"to delete."
) % {'errors': errors, 'total': total}
raise exceptions.CommandError(msg)
return None
class ListApplicationCredential(command.Lister):
_description = _("List application credentials")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'--user',
metavar='<user>',
help=_('User whose application credentials to list (name or ID)'),
)
common.add_user_domain_option_to_parser(parser)
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.sdk_connection.identity
if parsed_args.user:
user_id = common.find_user_id_sdk(
identity_client, parsed_args.user, parsed_args.user_domain
)
else:
conn = self.app.client_manager.sdk_connection
user_id = conn.config.get_auth().get_user_id(conn.identity)
application_credentials = identity_client.application_credentials(
user=user_id
)
return _format_application_credentials(application_credentials)
class ShowApplicationCredential(command.ShowOne):
_description = _("Display application credential details")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'application_credential',
metavar='<application-credential>',
help=_('Application credential to display (name or ID)'),
)
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.sdk_connection.identity
conn = self.app.client_manager.sdk_connection
user_id = conn.config.get_auth().get_user_id(conn.identity)
application_credential = identity_client.find_application_credential(
user_id, parsed_args.application_credential
)
return _format_application_credential(application_credential)
|