/usr/lib/python3/dist-packages/oslo_context/context.py is in python3-oslo.context 1:2.20.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 | # Copyright 2011 OpenStack Foundation.
# All Rights Reserved.
#
# 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.
"""
Base class for holding contextual information of a request
This class has several uses:
* Used for storing security information in a web request.
* Used for passing contextual details to oslo.log.
Projects should subclass this class if they wish to enhance the request
context or provide additional information in their specific WSGI pipeline
or logging context.
"""
import collections
import functools
import itertools
import threading
import uuid
import warnings
import debtcollector
from debtcollector import renames
_request_store = threading.local()
# These arguments will be passed to a new context from the first available
# header to support backwards compatibility.
_ENVIRON_HEADERS = {
'auth_token': ['HTTP_X_AUTH_TOKEN',
'HTTP_X_STORAGE_TOKEN'],
'user_id': ['HTTP_X_USER_ID',
'HTTP_X_USER'],
'project_id': ['HTTP_X_PROJECT_ID',
'HTTP_X_TENANT_ID',
'HTTP_X_TENANT'],
'user_domain_id': ['HTTP_X_USER_DOMAIN_ID'],
'project_domain_id': ['HTTP_X_PROJECT_DOMAIN_ID'],
'user_name': ['HTTP_X_USER_NAME'],
'project_name': ['HTTP_X_PROJECT_NAME',
'HTTP_X_TENANT_NAME'],
'user_domain_name': ['HTTP_X_USER_DOMAIN_NAME'],
'project_domain_name': ['HTTP_X_PROJECT_DOMAIN_NAME'],
'request_id': ['openstack.request_id'],
'global_request_id': ['openstack.global_request_id'],
'service_token': ['HTTP_X_SERVICE_TOKEN'],
'service_user_id': ['HTTP_X_SERVICE_USER_ID'],
'service_user_name': ['HTTP_X_SERVICE_USER_NAME'],
'service_user_domain_id': ['HTTP_X_SERVICE_USER_DOMAIN_ID'],
'service_user_domain_name': ['HTTP_X_SERVICE_USER_DOMAIN_NAME'],
'service_project_id': ['HTTP_X_SERVICE_PROJECT_ID'],
'service_project_name': ['HTTP_X_SERVICE_PROJECT_NAME'],
'service_project_domain_id': ['HTTP_X_SERVICE_PROJECT_DOMAIN_ID'],
'service_project_domain_name': ['HTTP_X_SERVICE_PROJECT_DOMAIN_NAME'],
}
def generate_request_id():
"""Generate a unique request id."""
return 'req-%s' % uuid.uuid4()
class _DeprecatedPolicyValues(collections.MutableMapping):
"""A Dictionary that manages current and deprecated policy values.
Anything added to this dictionary after initial creation is considered a
deprecated key that we are trying to move services away from. Accessing
these values as oslo.policy will do will trigger a DeprecationWarning.
"""
def __init__(self, data):
self._data = data
self._deprecated = {}
def __getitem__(self, k):
try:
return self._data[k]
except KeyError:
pass
try:
val = self._deprecated[k]
except KeyError:
pass
else:
warnings.warn('Policy enforcement is depending on the value of '
'%s. This key is deprecated. Please update your '
'policy file to use the standard policy values.' % k,
DeprecationWarning)
return val
raise KeyError(k)
def __setitem__(self, k, v):
self._deprecated[k] = v
def __delitem__(self, k):
del self._deprecated[k]
def __iter__(self):
return iter(self._dict)
def __len__(self):
return len(self._dict)
def __str__(self):
return self._dict.__str__()
def __repr__(self):
return self._dict.__repr__()
@property
def _dict(self):
d = self._deprecated.copy()
d.update(self._data)
return d
def _moved_msg(new_name, old_name):
if old_name:
deprecated_msg = "Property '%(old_name)s' has moved to '%(new_name)s'"
deprecated_msg = deprecated_msg % {'old_name': old_name,
'new_name': new_name}
debtcollector.deprecate(deprecated_msg,
version='2.6',
removal_version='3.0',
stacklevel=5)
def _moved_property(new_name, old_name=None, target=None):
if not target:
target = new_name
def getter(self):
_moved_msg(new_name, old_name)
return getattr(self, target)
def setter(self, value):
_moved_msg(new_name, old_name)
setattr(self, target, value)
def deleter(self):
_moved_msg(new_name, old_name)
delattr(self, target)
return property(getter, setter, deleter)
_renamed_kwarg = functools.partial(renames.renamed_kwarg,
version='2.18',
removal_version='3.0',
replace=True)
class RequestContext(object):
"""Helper class to represent useful information about a request context.
Stores information about the security context under which the user
accesses the system, as well as additional request information.
"""
user_idt_format = u'{user} {tenant} {domain} {user_domain} {p_domain}'
# Can be overridden in subclasses to specify extra keys that should be
# read when constructing a context using from_dict.
FROM_DICT_EXTRA_KEYS = []
@_renamed_kwarg('user', 'user_id')
@_renamed_kwarg('tenant', 'project_id')
@_renamed_kwarg('domain', 'domain_id')
@_renamed_kwarg('user_domain', 'user_domain_id')
@_renamed_kwarg('project_domain', 'project_domain_id')
def __init__(self,
auth_token=None,
user_id=None,
project_id=None,
domain_id=None,
user_domain_id=None,
project_domain_id=None,
is_admin=False,
read_only=False,
show_deleted=False,
request_id=None,
resource_uuid=None,
overwrite=True,
roles=None,
user_name=None,
project_name=None,
domain_name=None,
user_domain_name=None,
project_domain_name=None,
is_admin_project=True,
service_token=None,
service_user_id=None,
service_user_name=None,
service_user_domain_id=None,
service_user_domain_name=None,
service_project_id=None,
service_project_name=None,
service_project_domain_id=None,
service_project_domain_name=None,
service_roles=None,
global_request_id=None):
"""Initialize the RequestContext
:param overwrite: Set to False to ensure that the greenthread local
copy of the index is not overwritten.
:param is_admin_project: Whether the specified project is specified in
the token as the admin project. Defaults to
True for backwards compatibility.
:type is_admin_project: bool
"""
# setting to private variables to avoid triggering subclass properties
self._user_id = user_id
self._project_id = project_id
self._domain_id = domain_id
self._user_domain_id = user_domain_id
self._project_domain_id = project_domain_id
self.auth_token = auth_token
self.user_name = user_name
self.project_name = project_name
self.domain_name = domain_name
self.user_domain_name = user_domain_name
self.project_domain_name = project_domain_name
self.is_admin = is_admin
self.is_admin_project = is_admin_project
self.read_only = read_only
self.show_deleted = show_deleted
self.resource_uuid = resource_uuid
self.roles = roles or []
self.service_token = service_token
self.service_user_id = service_user_id
self.service_user_name = service_user_name
self.service_user_domain_id = service_user_domain_id
self.service_user_domain_name = service_user_domain_name
self.service_project_id = service_project_id
self.service_project_name = service_project_name
self.service_project_domain_id = service_project_domain_id
self.service_project_domain_name = service_project_domain_name
self.service_roles = service_roles or []
if not request_id:
request_id = generate_request_id()
self.request_id = request_id
self.global_request_id = global_request_id
if overwrite or not get_current():
self.update_store()
# NOTE(jamielennox): To prevent circular lookups on subclasses that might
# point user to user_id we make user/user_id tenant/project_id etc point
# to the same private variable rather than each other.
tenant = _moved_property('project_id', 'tenant', target='_project_id')
user = _moved_property('user_id', 'user', target='_user_id')
domain = _moved_property('domain_id', 'domain', target='_domain_id')
user_domain = _moved_property('user_domain_id',
'user_domain',
target='_user_domain_id')
project_domain = _moved_property('project_domain_id',
'project_domain',
target='_project_domain_id')
user_id = _moved_property('_user_id')
project_id = _moved_property('_project_id')
domain_id = _moved_property('_domain_id')
user_domain_id = _moved_property('_user_domain_id')
project_domain_id = _moved_property('_project_domain_id')
def update_store(self):
"""Store the context in the current thread."""
_request_store.context = self
def to_policy_values(self):
"""A dictionary of context attributes to enforce policy with.
oslo.policy enforcement requires a dictionary of attributes
representing the current logged in user on which it applies policy
enforcement. This dictionary defines a standard list of attributes that
should be available for enforcement across services.
It is expected that services will often have to override this method
with either deprecated values or additional attributes used by that
service specific policy.
"""
# NOTE(jamielennox): We need a way to allow projects to provide old
# deprecated policy values that trigger a warning when used in favour
# of our standard ones. This object acts like a dict but only values
# from oslo.policy don't show a warning.
return _DeprecatedPolicyValues({
'user_id': self.user_id,
'user_domain_id': self.user_domain_id,
'project_id': self.project_id,
'project_domain_id': self.project_domain_id,
'roles': self.roles,
'is_admin_project': self.is_admin_project,
'service_user_id': self.service_user_id,
'service_user_domain_id': self.service_user_domain_id,
'service_project_id': self.service_project_id,
'service_project_domain_id': self.service_project_domain_id,
'service_roles': self.service_roles})
def to_dict(self):
"""Return a dictionary of context attributes."""
user_idt = self.user_idt_format.format(
user=self.user_id or '-',
tenant=self.project_id or '-',
domain=self.domain_id or '-',
user_domain=self.user_domain_id or '-',
p_domain=self.project_domain_id or '-')
return {'user': self.user_id,
'tenant': self.project_id,
'project': self.project_id,
'domain': self.domain_id,
'user_domain': self.user_domain_id,
'project_domain': self.project_domain_id,
'is_admin': self.is_admin,
'read_only': self.read_only,
'show_deleted': self.show_deleted,
'auth_token': self.auth_token,
'request_id': self.request_id,
'global_request_id': self.global_request_id,
'resource_uuid': self.resource_uuid,
'roles': self.roles,
'user_identity': user_idt,
'is_admin_project': self.is_admin_project}
def get_logging_values(self):
"""Return a dictionary of logging specific context attributes."""
values = {'user_name': self.user_name,
'project_name': self.project_name,
'domain_name': self.domain_name,
'user_domain_name': self.user_domain_name,
'project_domain_name': self.project_domain_name}
values.update(self.to_dict())
if self.auth_token:
# NOTE(jaosorior): Gotta obfuscate the token since this dict is
# meant for logging and we shouldn't leak it.
values['auth_token'] = '***'
else:
values['auth_token'] = None
return values
@property
def global_id(self):
"""Return a sensible value for global_id to pass on.
When we want to make a call with to another service, it's
important that we try to use global_request_id if available,
and fall back to the locally generated request_id if not.
"""
return self.global_request_id or self.request_id
@classmethod
@_renamed_kwarg('user', 'user_id')
@_renamed_kwarg('tenant', 'project_id')
@_renamed_kwarg('domain', 'domain_id')
@_renamed_kwarg('user_domain', 'user_domain_id')
@_renamed_kwarg('project_domain', 'project_domain_id')
def from_dict(cls, values, **kwargs):
"""Construct a context object from a provided dictionary."""
kwargs.setdefault('auth_token', values.get('auth_token'))
kwargs.setdefault('user_id', values.get('user'))
kwargs.setdefault('project_id', values.get('tenant'))
kwargs.setdefault('domain_id', values.get('domain'))
kwargs.setdefault('user_domain_id', values.get('user_domain'))
kwargs.setdefault('project_domain_id', values.get('project_domain'))
kwargs.setdefault('is_admin', values.get('is_admin', False))
kwargs.setdefault('read_only', values.get('read_only', False))
kwargs.setdefault('show_deleted', values.get('show_deleted', False))
kwargs.setdefault('request_id', values.get('request_id'))
kwargs.setdefault('global_request_id', values.get('global_request_id'))
kwargs.setdefault('resource_uuid', values.get('resource_uuid'))
kwargs.setdefault('roles', values.get('roles'))
kwargs.setdefault('user_name', values.get('user_name'))
kwargs.setdefault('project_name', values.get('project_name'))
kwargs.setdefault('domain_name', values.get('domain_name'))
kwargs.setdefault('user_domain_name', values.get('user_domain_name'))
kwargs.setdefault('project_domain_name',
values.get('project_domain_name'))
kwargs.setdefault('is_admin_project',
values.get('is_admin_project', True))
for key in cls.FROM_DICT_EXTRA_KEYS:
kwargs.setdefault(key, values.get(key))
return cls(**kwargs)
@classmethod
@_renamed_kwarg('user', 'user_id')
@_renamed_kwarg('tenant', 'project_id')
@_renamed_kwarg('domain', 'domain_id')
@_renamed_kwarg('user_domain', 'user_domain_id')
@_renamed_kwarg('project_domain', 'project_domain_id')
def from_environ(cls, environ, **kwargs):
"""Load a context object from a request environment.
If keyword arguments are provided then they override the values in the
request environment.
:param environ: The environment dictionary associated with a request.
:type environ: dict
"""
# Load a new context object from the environment variables set by
# auth_token middleware. See:
# https://docs.openstack.org/keystonemiddleware/latest/api/keystonemiddleware.auth_token.html#what-auth-token-adds-to-the-request-for-use-by-the-openstack-service
# add kwarg if not specified by user from a list of possible headers
for k, v_list in _ENVIRON_HEADERS.items():
if k in kwargs:
continue
for v in v_list:
if v in environ:
kwargs[k] = environ[v]
break
if 'roles' not in kwargs:
roles = environ.get('HTTP_X_ROLES', environ.get('HTTP_X_ROLE'))
roles = [r.strip() for r in roles.split(',')] if roles else []
kwargs['roles'] = roles
if 'service_roles' not in kwargs:
roles = environ.get('HTTP_X_SERVICE_ROLES')
roles = [r.strip() for r in roles.split(',')] if roles else []
kwargs['service_roles'] = roles
if 'is_admin_project' not in kwargs:
# NOTE(jamielennox): we default is_admin_project to true because if
# nothing is provided we have to assume it is the admin project to
# make old policy continue to work.
is_admin_proj_str = environ.get('HTTP_X_IS_ADMIN_PROJECT', 'true')
kwargs['is_admin_project'] = is_admin_proj_str.lower() == 'true'
return cls(**kwargs)
def get_admin_context(show_deleted=False):
"""Create an administrator context."""
context = RequestContext(None,
project_id=None,
is_admin=True,
show_deleted=show_deleted,
overwrite=False)
return context
def get_context_from_function_and_args(function, args, kwargs):
"""Find an arg of type RequestContext and return it.
This is useful in a couple of decorators where we don't
know much about the function we're wrapping.
"""
for arg in itertools.chain(kwargs.values(), args):
if isinstance(arg, RequestContext):
return arg
return None
def is_user_context(context):
"""Indicates if the request context is a normal user."""
if not context or not isinstance(context, RequestContext):
return False
if context.is_admin:
return False
return True
def get_current():
"""Return this thread's current context
If no context is set, returns None
"""
return getattr(_request_store, 'context', None)
|