Add the new Keystone TokenModel
This commit adds the new Keystone TokenModel that will be used to unify in-memory references for tokens. The initial implementation of this model works similarly to the AccessInfo model from keystoneclient, providing a unified set of properties that will return the data from the token-version specific locations. Future development will round this model out to be better suited as an authoratative token data source that can be transformed into any token format / version. Change-Id: I341e03ac8483f8d6085f4c2c218a28647b9ff2e4 bp: non-persistent-tokens
This commit is contained in:
Morgan Fainberg
parent
f44da98856
commit
2e029f545e
|
|
@ -373,3 +373,8 @@ class MigrationNotProvided(Exception):
|
|||
"%(mod_name)s doesn't provide database migrations. The migration"
|
||||
" repository path at %(path)s doesn't exist or isn't a directory."
|
||||
) % {'mod_name': mod_name, 'path': path})
|
||||
|
||||
|
||||
class UnsupportedTokenVersionException(Exception):
|
||||
"""Token version is unrecognizable or unsupported."""
|
||||
pass
|
||||
|
|
|
|||
|
|
@ -0,0 +1,259 @@
|
|||
# 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.
|
||||
|
||||
"""Unified in-memory token model."""
|
||||
|
||||
import six
|
||||
|
||||
from keystone.common import config
|
||||
from keystone import exception
|
||||
from keystone.i18n import _
|
||||
from keystone.openstack.common import timeutils
|
||||
|
||||
|
||||
CONF = config.CONF
|
||||
# supported token versions
|
||||
V2 = 'v2.0'
|
||||
V3 = 'v3.0'
|
||||
VERSIONS = frozenset([V2, V3])
|
||||
|
||||
|
||||
def _parse_and_normalize_time(time_data):
|
||||
if isinstance(time_data, six.string_types):
|
||||
time_data = timeutils.parse_isotime(time_data)
|
||||
return timeutils.normalize_time(time_data)
|
||||
|
||||
|
||||
class KeystoneToken(dict):
|
||||
"""An in-memory representation that unifies v2 and v3 tokens."""
|
||||
# TODO(morganfainberg): Align this in-memory representation with the
|
||||
# objects in keystoneclient. This object should be eventually updated
|
||||
# to be the source of token data with the ability to emit any version
|
||||
# of the token instead of only consuming the token dict and providing
|
||||
# property accessors for the underlying data.
|
||||
|
||||
def __init__(self, token_id, token_data):
|
||||
self.token_data = token_data
|
||||
if 'access' in token_data:
|
||||
super(KeystoneToken, self).__init__(**token_data['access'])
|
||||
self.version = V2
|
||||
elif 'token' in token_data and 'methods' in token_data['token']:
|
||||
super(KeystoneToken, self).__init__(**token_data['token'])
|
||||
self.version = V3
|
||||
else:
|
||||
raise exception.UnsupportedTokenVersionException()
|
||||
self.token_id = token_id
|
||||
|
||||
if self.project_scoped and self.domain_scoped:
|
||||
raise exception.UnexpectedError(_('Found invalid token: scoped to '
|
||||
'both project and domain.'))
|
||||
|
||||
@property
|
||||
def expires(self):
|
||||
if self.version is V3:
|
||||
expires_at = self['expires_at']
|
||||
else:
|
||||
expires_at = self['token']['expires']
|
||||
return _parse_and_normalize_time(expires_at)
|
||||
|
||||
@property
|
||||
def issued(self):
|
||||
if self.version is V3:
|
||||
issued_at = self['issued_at']
|
||||
else:
|
||||
issued_at = self['token']['issued_at']
|
||||
return _parse_and_normalize_time(issued_at)
|
||||
|
||||
@property
|
||||
def auth_token(self):
|
||||
return self.token_id
|
||||
|
||||
@property
|
||||
def user_id(self):
|
||||
return self['user']['id']
|
||||
|
||||
@property
|
||||
def user_name(self):
|
||||
return self['user']['name']
|
||||
|
||||
@property
|
||||
def user_domain_name(self):
|
||||
try:
|
||||
if self.version == V3:
|
||||
return self['user']['domain']['name']
|
||||
elif 'user' in self:
|
||||
return "Default"
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
pass
|
||||
raise exception.UnexpectedError()
|
||||
|
||||
@property
|
||||
def user_domain_id(self):
|
||||
try:
|
||||
if self.version == V3:
|
||||
return self['user']['domain']['id']
|
||||
elif 'user' in self:
|
||||
return CONF.identity.default_domain_id
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
pass
|
||||
raise exception.UnexpectedError()
|
||||
|
||||
@property
|
||||
def domain_id(self):
|
||||
if self.version is V3:
|
||||
try:
|
||||
return self['domain']['id']
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
raise exception.UnexpectedError()
|
||||
# No domain scoped tokens in V2.
|
||||
raise NotImplementedError()
|
||||
|
||||
@property
|
||||
def domain_name(self):
|
||||
if self.version is V3:
|
||||
try:
|
||||
return self['domain']['name']
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
raise exception.UnexpectedError()
|
||||
# No domain scoped tokens in V2.
|
||||
raise NotImplementedError()
|
||||
|
||||
@property
|
||||
def project_id(self):
|
||||
try:
|
||||
if self.version is V3:
|
||||
return self['project']['id']
|
||||
else:
|
||||
return self['token']['tenant']['id']
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
raise exception.UnexpectedError()
|
||||
|
||||
@property
|
||||
def project_name(self):
|
||||
try:
|
||||
if self.version is V3:
|
||||
return self['project']['name']
|
||||
else:
|
||||
return self['token']['tenant']['name']
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
raise exception.UnexpectedError()
|
||||
|
||||
@property
|
||||
def project_domain_id(self):
|
||||
try:
|
||||
if self.version is V3:
|
||||
return self['project']['domain']['id']
|
||||
elif 'tenant' in self['token']:
|
||||
return CONF.identity.default_domain_id
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
pass
|
||||
|
||||
raise exception.UnexpectedError()
|
||||
|
||||
@property
|
||||
def project_domain_name(self):
|
||||
try:
|
||||
if self.version is V3:
|
||||
return self['project']['domain']['name']
|
||||
if 'tenant' in self['token']:
|
||||
return 'Default'
|
||||
except KeyError:
|
||||
# Do not raise KeyError, raise UnexpectedError
|
||||
pass
|
||||
|
||||
raise exception.UnexpectedError()
|
||||
|
||||
@property
|
||||
def project_scoped(self):
|
||||
if self.version is V3:
|
||||
return 'project' in self
|
||||
else:
|
||||
return 'tenant' in self['token']
|
||||
|
||||
@property
|
||||
def domain_scoped(self):
|
||||
if self.version is V3:
|
||||
return 'domain' in self
|
||||
return False
|
||||
|
||||
@property
|
||||
def scoped(self):
|
||||
return self.project_scoped or self.domain_scoped
|
||||
|
||||
@property
|
||||
def trust_id(self):
|
||||
if self.version is V3:
|
||||
return self.get('OS-TRUST:trust', {}).get('id')
|
||||
else:
|
||||
return self.get('trust', {}).get('id')
|
||||
|
||||
@property
|
||||
def trust_scoped(self):
|
||||
if self.version is V3:
|
||||
return 'OS-TRUST:trust' in self
|
||||
else:
|
||||
return 'trust' in self
|
||||
|
||||
@property
|
||||
def trustee_user_id(self):
|
||||
if self.version is V3:
|
||||
return self.get(
|
||||
'OS-TRUST:trust', {}).get('trustee_user_id')
|
||||
else:
|
||||
return self.get('trust', {}).get('trustee_user_id')
|
||||
|
||||
@property
|
||||
def trustor_user_id(self):
|
||||
if self.version is V3:
|
||||
return self.get(
|
||||
'OS-TRUST:trust', {}).get('trustor_user_id')
|
||||
else:
|
||||
return self.get('trust', {}).get('trustor_user_id')
|
||||
|
||||
@property
|
||||
def oauth_access_token_id(self):
|
||||
if self.version is V3:
|
||||
return self.get('OS-OAUTH1', {}).get('access_token_id')
|
||||
return None
|
||||
|
||||
@property
|
||||
def oauth_consumer_id(self):
|
||||
if self.version is V3:
|
||||
return self.get('OS-OAUTH1', {}).get('consumer_id')
|
||||
return None
|
||||
|
||||
@property
|
||||
def role_ids(self):
|
||||
if self.version is V3:
|
||||
return [r['id'] for r in self.get('roles', [])]
|
||||
else:
|
||||
return self.get('metadata', {}).get('roles', [])
|
||||
|
||||
@property
|
||||
def role_names(self):
|
||||
if self.version is V3:
|
||||
return [r['name'] for r in self.get('roles', [])]
|
||||
else:
|
||||
return [r['name'] for r in self['user'].get('roles', [])]
|
||||
|
||||
@property
|
||||
def bind(self):
|
||||
if self.version is V3:
|
||||
return self.get('bind')
|
||||
return self.get('token', {}).get('bind')
|
||||
|
|
@ -722,7 +722,7 @@ class TestTokenProvider(tests.TestCase):
|
|||
token.provider.V3,
|
||||
self.token_provider_api.get_token_version(
|
||||
SAMPLE_V3_TOKEN_WITH_EMBEDED_VERSION))
|
||||
self.assertRaises(token.provider.UnsupportedTokenVersionException,
|
||||
self.assertRaises(exception.UnsupportedTokenVersionException,
|
||||
self.token_provider_api.get_token_version,
|
||||
'bogus')
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,191 @@
|
|||
# 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.
|
||||
|
||||
import copy
|
||||
import uuid
|
||||
|
||||
from keystone.common import config
|
||||
from keystone import exception
|
||||
from keystone.models import token_model
|
||||
from keystone.openstack.common import timeutils
|
||||
from keystone.tests import core
|
||||
from keystone.tests import test_token_provider
|
||||
|
||||
|
||||
CONF = config.CONF
|
||||
|
||||
|
||||
class TestKeystoneTokenModel(core.TestCase):
|
||||
def setUp(self):
|
||||
super(TestKeystoneTokenModel, self).setUp()
|
||||
self.load_backends()
|
||||
self.v2_sample_token = copy.deepcopy(
|
||||
test_token_provider.SAMPLE_V2_TOKEN)
|
||||
self.v3_sample_token = copy.deepcopy(
|
||||
test_token_provider.SAMPLE_V3_TOKEN)
|
||||
|
||||
def test_token_model_v3(self):
|
||||
token_data = token_model.KeystoneToken(uuid.uuid4().hex,
|
||||
self.v3_sample_token)
|
||||
self.assertIs(token_model.V3, token_data.version)
|
||||
expires = timeutils.normalize_time(timeutils.parse_isotime(
|
||||
self.v3_sample_token['token']['expires_at']))
|
||||
issued = timeutils.normalize_time(timeutils.parse_isotime(
|
||||
self.v3_sample_token['token']['issued_at']))
|
||||
self.assertEqual(expires, token_data.expires)
|
||||
self.assertEqual(issued, token_data.issued)
|
||||
self.assertEqual(self.v3_sample_token['token']['user']['id'],
|
||||
token_data.user_id)
|
||||
self.assertEqual(self.v3_sample_token['token']['user']['name'],
|
||||
token_data.user_name)
|
||||
self.assertEqual(self.v3_sample_token['token']['user']['domain']['id'],
|
||||
token_data.user_domain_id)
|
||||
self.assertEqual(
|
||||
self.v3_sample_token['token']['user']['domain']['name'],
|
||||
token_data.user_domain_name)
|
||||
self.assertEqual(
|
||||
self.v3_sample_token['token']['project']['domain']['id'],
|
||||
token_data.project_domain_id)
|
||||
self.assertEqual(
|
||||
self.v3_sample_token['token']['project']['domain']['name'],
|
||||
token_data.project_domain_name)
|
||||
self.assertEqual(self.v3_sample_token['token']['OS-TRUST:trust']['id'],
|
||||
token_data.trust_id)
|
||||
self.assertEqual(
|
||||
self.v3_sample_token['token']['OS-TRUST:trust']['trustor_user_id'],
|
||||
token_data.trustor_user_id)
|
||||
self.assertEqual(
|
||||
self.v3_sample_token['token']['OS-TRUST:trust']['trustee_user_id'],
|
||||
token_data.trustee_user_id)
|
||||
# Project Scoped Token
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'domain_id')
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'domain_name')
|
||||
self.assertFalse(token_data.domain_scoped)
|
||||
self.assertEqual(self.v3_sample_token['token']['project']['id'],
|
||||
token_data.project_id)
|
||||
self.assertEqual(self.v3_sample_token['token']['project']['name'],
|
||||
token_data.project_name)
|
||||
self.assertTrue(token_data.project_scoped)
|
||||
self.assertTrue(token_data.scoped)
|
||||
self.assertTrue(token_data.trust_scoped)
|
||||
self.assertEqual(
|
||||
[r['id'] for r in self.v3_sample_token['token']['roles']],
|
||||
token_data.role_ids)
|
||||
self.assertEqual(
|
||||
[r['name'] for r in self.v3_sample_token['token']['roles']],
|
||||
token_data.role_names)
|
||||
self.assertTrue(token_data.project_scoped)
|
||||
token_data.pop('project')
|
||||
self.assertFalse(token_data.project_scoped)
|
||||
self.assertFalse(token_data.scoped)
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'project_id')
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'project_name')
|
||||
self.assertFalse(token_data.project_scoped)
|
||||
domain_id = uuid.uuid4().hex
|
||||
domain_name = uuid.uuid4().hex
|
||||
token_data['domain'] = {'id': domain_id,
|
||||
'name': domain_name}
|
||||
self.assertEqual(domain_id, token_data.domain_id)
|
||||
self.assertEqual(domain_name, token_data.domain_name)
|
||||
self.assertTrue(token_data.domain_scoped)
|
||||
|
||||
def test_token_model_v2(self):
|
||||
token_data = token_model.KeystoneToken(uuid.uuid4().hex,
|
||||
self.v2_sample_token)
|
||||
self.assertIs(token_model.V2, token_data.version)
|
||||
expires = timeutils.normalize_time(timeutils.parse_isotime(
|
||||
self.v2_sample_token['access']['token']['expires']))
|
||||
issued = timeutils.normalize_time(timeutils.parse_isotime(
|
||||
self.v2_sample_token['access']['token']['issued_at']))
|
||||
self.assertEqual(expires, token_data.expires)
|
||||
self.assertEqual(issued, token_data.issued)
|
||||
self.assertEqual(self.v2_sample_token['access']['user']['id'],
|
||||
token_data.user_id)
|
||||
self.assertEqual(self.v2_sample_token['access']['user']['name'],
|
||||
token_data.user_name)
|
||||
self.assertEqual(CONF.identity.default_domain_id,
|
||||
token_data.user_domain_id)
|
||||
self.assertEqual('Default', token_data.user_domain_name)
|
||||
self.assertEqual(CONF.identity.default_domain_id,
|
||||
token_data.project_domain_id)
|
||||
self.assertEqual('Default',
|
||||
token_data.project_domain_name)
|
||||
self.assertEqual(self.v2_sample_token['access']['trust']['id'],
|
||||
token_data.trust_id)
|
||||
self.assertIsNone(token_data.trustor_user_id)
|
||||
self.assertEqual(
|
||||
self.v2_sample_token['access']['trust']['trustee_user_id'],
|
||||
token_data.trustee_user_id)
|
||||
# Project Scoped Token
|
||||
self.assertEqual(
|
||||
self.v2_sample_token['access']['token']['tenant']['id'],
|
||||
token_data.project_id)
|
||||
self.assertEqual(
|
||||
self.v2_sample_token['access']['token']['tenant']['name'],
|
||||
token_data.project_name)
|
||||
self.assertTrue(token_data.project_scoped)
|
||||
self.assertTrue(token_data.scoped)
|
||||
self.assertTrue(token_data.trust_scoped)
|
||||
self.assertEqual(
|
||||
[r['name']
|
||||
for r in self.v2_sample_token['access']['user']['roles']],
|
||||
token_data.role_names)
|
||||
token_data['token'].pop('tenant')
|
||||
self.assertFalse(token_data.scoped)
|
||||
self.assertFalse(token_data.project_scoped)
|
||||
self.assertFalse(token_data.domain_scoped)
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'project_id')
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'project_name')
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'project_domain_id')
|
||||
self.assertRaises(exception.UnexpectedError, getattr, token_data,
|
||||
'project_domain_id')
|
||||
# No Domain Scoped tokens in V2
|
||||
self.assertRaises(NotImplementedError, getattr, token_data,
|
||||
'domain_id')
|
||||
self.assertRaises(NotImplementedError, getattr, token_data,
|
||||
'domain_name')
|
||||
self.assertFalse(token_data.domain_scoped)
|
||||
token_data['domain'] = {'id': uuid.uuid4().hex,
|
||||
'name': uuid.uuid4().hex}
|
||||
self.assertRaises(NotImplementedError, getattr, token_data,
|
||||
'domain_id')
|
||||
self.assertRaises(NotImplementedError, getattr, token_data,
|
||||
'domain_name')
|
||||
self.assertFalse(token_data.domain_scoped)
|
||||
|
||||
def test_token_model_unknown(self):
|
||||
self.assertRaises(exception.UnsupportedTokenVersionException,
|
||||
token_model.KeystoneToken,
|
||||
token_id=uuid.uuid4().hex,
|
||||
token_data={'bogus_data': uuid.uuid4().hex})
|
||||
|
||||
def test_token_model_dual_scoped_token(self):
|
||||
domain = {'id': uuid.uuid4().hex,
|
||||
'name': uuid.uuid4().hex}
|
||||
self.v2_sample_token['access']['domain'] = domain
|
||||
self.v3_sample_token['token']['domain'] = domain
|
||||
|
||||
# V2 Tokens Cannot be domain scoped, this should work
|
||||
token_model.KeystoneToken(token_id=uuid.uuid4().hex,
|
||||
token_data=self.v2_sample_token)
|
||||
|
||||
self.assertRaises(exception.UnexpectedError,
|
||||
token_model.KeystoneToken,
|
||||
token_id=uuid.uuid4().hex,
|
||||
token_data=self.v3_sample_token)
|
||||
|
|
@ -126,7 +126,7 @@ class Token(token.persistence.Driver):
|
|||
trustee_user_id = token_data['OS-TRUST:trust'][
|
||||
'trustee_user_id']
|
||||
else:
|
||||
raise token.provider.UnsupportedTokenVersionException(
|
||||
raise exception.UnsupportedTokenVersionException(
|
||||
_('Unknown token version %s') %
|
||||
data_copy.get('token_version'))
|
||||
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@ from keystone.common import cache
|
|||
from keystone.common import dependency
|
||||
from keystone.common import manager
|
||||
from keystone import config
|
||||
|
||||
from keystone import exception
|
||||
from keystone.i18n import _
|
||||
from keystone.models import token_model
|
||||
from keystone.openstack.common import log
|
||||
from keystone.openstack.common import timeutils
|
||||
from keystone.openstack.common import versionutils
|
||||
|
|
@ -40,9 +40,9 @@ SHOULD_CACHE = cache.should_cache_fn('token')
|
|||
EXPIRATION_TIME = lambda: CONF.token.cache_time
|
||||
|
||||
# supported token versions
|
||||
V2 = 'v2.0'
|
||||
V3 = 'v3.0'
|
||||
VERSIONS = frozenset([V2, V3])
|
||||
V2 = token_model.V2
|
||||
V3 = token_model.V3
|
||||
VERSIONS = token_model.VERSIONS
|
||||
|
||||
# default token providers
|
||||
PKI_PROVIDER = 'keystone.token.providers.pki.Provider'
|
||||
|
|
@ -57,11 +57,6 @@ _FORMAT_TO_PROVIDER = {
|
|||
}
|
||||
|
||||
|
||||
class UnsupportedTokenVersionException(Exception):
|
||||
"""Token version is unrecognizable or unsupported."""
|
||||
pass
|
||||
|
||||
|
||||
def default_expire_time():
|
||||
"""Determine when a fresh token should expire.
|
||||
|
||||
|
|
@ -84,6 +79,10 @@ class Manager(manager.Manager):
|
|||
|
||||
"""
|
||||
|
||||
V2 = V2
|
||||
V3 = V3
|
||||
VERSIONS = VERSIONS
|
||||
|
||||
@classmethod
|
||||
def get_token_provider(cls):
|
||||
"""Return package path to the configured token provider.
|
||||
|
|
|
|||
|
|
@ -387,7 +387,7 @@ class BaseProvider(provider.Provider):
|
|||
return token.provider.V2
|
||||
if 'token' in token_data and 'methods' in token_data['token']:
|
||||
return token.provider.V3
|
||||
raise token.provider.UnsupportedTokenVersionException()
|
||||
raise exception.UnsupportedTokenVersionException()
|
||||
|
||||
def issue_v2_token(self, token_ref, roles_ref=None,
|
||||
catalog_ref=None):
|
||||
|
|
@ -649,4 +649,4 @@ class BaseProvider(provider.Provider):
|
|||
return self._validate_v3_token_ref(token_ref)
|
||||
elif version == token.provider.V2:
|
||||
return self._validate_v2_token_ref(token_ref)
|
||||
raise token.provider.UnsupportedTokenVersionException()
|
||||
raise exception.UnsupportedTokenVersionException()
|
||||
|
|
|
|||
Loading…
Reference in New Issue