262 lines
9.5 KiB
Python
262 lines
9.5 KiB
Python
# 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.
|
|
|
|
"""Main entry point into the Revoke service."""
|
|
|
|
import abc
|
|
import datetime
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log
|
|
from oslo_log import versionutils
|
|
from oslo_utils import timeutils
|
|
import six
|
|
|
|
from keystone.common import cache
|
|
from keystone.common import dependency
|
|
from keystone.common import extension
|
|
from keystone.common import manager
|
|
from keystone import exception
|
|
from keystone.i18n import _
|
|
from keystone import notifications
|
|
from keystone.revoke import model
|
|
|
|
|
|
CONF = cfg.CONF
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
EXTENSION_DATA = {
|
|
'name': 'OpenStack Revoke API',
|
|
'namespace': 'http://docs.openstack.org/identity/api/ext/'
|
|
'OS-REVOKE/v1.0',
|
|
'alias': 'OS-REVOKE',
|
|
'updated': '2014-02-24T20:51:0-00:00',
|
|
'description': 'OpenStack revoked token reporting mechanism.',
|
|
'links': [
|
|
{
|
|
'rel': 'describedby',
|
|
'type': 'text/html',
|
|
'href': 'http://specs.openstack.org/openstack/keystone-specs/api/'
|
|
'v3/identity-api-v3-os-revoke-ext.html',
|
|
}
|
|
]}
|
|
extension.register_admin_extension(EXTENSION_DATA['alias'], EXTENSION_DATA)
|
|
extension.register_public_extension(EXTENSION_DATA['alias'], EXTENSION_DATA)
|
|
|
|
MEMOIZE = cache.get_memoization_decorator(group='revoke')
|
|
|
|
|
|
def revoked_before_cutoff_time():
|
|
expire_delta = datetime.timedelta(
|
|
seconds=CONF.token.expiration + CONF.revoke.expiration_buffer)
|
|
oldest = timeutils.utcnow() - expire_delta
|
|
return oldest
|
|
|
|
|
|
@dependency.provider('revoke_api')
|
|
class Manager(manager.Manager):
|
|
"""Default pivot point for the Revoke backend.
|
|
|
|
Performs common logic for recording revocations.
|
|
|
|
See :mod:`keystone.common.manager.Manager` for more details on
|
|
how this dynamically calls the backend.
|
|
|
|
"""
|
|
|
|
driver_namespace = 'keystone.revoke'
|
|
|
|
def __init__(self):
|
|
super(Manager, self).__init__(CONF.revoke.driver)
|
|
self._register_listeners()
|
|
self.model = model
|
|
|
|
def _user_callback(self, service, resource_type, operation,
|
|
payload):
|
|
self.revoke_by_user(payload['resource_info'])
|
|
|
|
def _role_callback(self, service, resource_type, operation,
|
|
payload):
|
|
self.revoke(
|
|
model.RevokeEvent(role_id=payload['resource_info']))
|
|
|
|
def _project_callback(self, service, resource_type, operation,
|
|
payload):
|
|
self.revoke(
|
|
model.RevokeEvent(project_id=payload['resource_info']))
|
|
|
|
def _domain_callback(self, service, resource_type, operation,
|
|
payload):
|
|
self.revoke(
|
|
model.RevokeEvent(domain_id=payload['resource_info']))
|
|
|
|
def _trust_callback(self, service, resource_type, operation,
|
|
payload):
|
|
self.revoke(
|
|
model.RevokeEvent(trust_id=payload['resource_info']))
|
|
|
|
def _consumer_callback(self, service, resource_type, operation,
|
|
payload):
|
|
self.revoke(
|
|
model.RevokeEvent(consumer_id=payload['resource_info']))
|
|
|
|
def _access_token_callback(self, service, resource_type, operation,
|
|
payload):
|
|
self.revoke(
|
|
model.RevokeEvent(access_token_id=payload['resource_info']))
|
|
|
|
def _role_assignment_callback(self, service, resource_type, operation,
|
|
payload):
|
|
info = payload['resource_info']
|
|
self.revoke_by_grant(role_id=info['role_id'], user_id=info['user_id'],
|
|
domain_id=info.get('domain_id'),
|
|
project_id=info.get('project_id'))
|
|
|
|
def _register_listeners(self):
|
|
callbacks = {
|
|
notifications.ACTIONS.deleted: [
|
|
['OS-TRUST:trust', self._trust_callback],
|
|
['OS-OAUTH1:consumer', self._consumer_callback],
|
|
['OS-OAUTH1:access_token', self._access_token_callback],
|
|
['role', self._role_callback],
|
|
['user', self._user_callback],
|
|
['project', self._project_callback],
|
|
['role_assignment', self._role_assignment_callback]
|
|
],
|
|
notifications.ACTIONS.disabled: [
|
|
['user', self._user_callback],
|
|
['project', self._project_callback],
|
|
['domain', self._domain_callback],
|
|
],
|
|
notifications.ACTIONS.internal: [
|
|
[notifications.INVALIDATE_USER_TOKEN_PERSISTENCE,
|
|
self._user_callback],
|
|
]
|
|
}
|
|
|
|
for event, cb_info in callbacks.items():
|
|
for resource_type, callback_fns in cb_info:
|
|
notifications.register_event_callback(event, resource_type,
|
|
callback_fns)
|
|
|
|
def revoke_by_user(self, user_id):
|
|
return self.revoke(model.RevokeEvent(user_id=user_id))
|
|
|
|
def _assert_not_domain_and_project_scoped(self, domain_id=None,
|
|
project_id=None):
|
|
if domain_id is not None and project_id is not None:
|
|
msg = _('The revoke call must not have both domain_id and '
|
|
'project_id. This is a bug in the Keystone server. The '
|
|
'current request is aborted.')
|
|
raise exception.UnexpectedError(exception=msg)
|
|
|
|
@versionutils.deprecated(as_of=versionutils.deprecated.JUNO,
|
|
remove_in=0)
|
|
def revoke_by_expiration(self, user_id, expires_at,
|
|
domain_id=None, project_id=None):
|
|
|
|
self._assert_not_domain_and_project_scoped(domain_id=domain_id,
|
|
project_id=project_id)
|
|
|
|
self.revoke(
|
|
model.RevokeEvent(user_id=user_id,
|
|
expires_at=expires_at,
|
|
domain_id=domain_id,
|
|
project_id=project_id))
|
|
|
|
def revoke_by_audit_id(self, audit_id):
|
|
self.revoke(model.RevokeEvent(audit_id=audit_id))
|
|
|
|
def revoke_by_audit_chain_id(self, audit_chain_id, project_id=None,
|
|
domain_id=None):
|
|
|
|
self._assert_not_domain_and_project_scoped(domain_id=domain_id,
|
|
project_id=project_id)
|
|
|
|
self.revoke(model.RevokeEvent(audit_chain_id=audit_chain_id,
|
|
domain_id=domain_id,
|
|
project_id=project_id))
|
|
|
|
def revoke_by_grant(self, role_id, user_id=None,
|
|
domain_id=None, project_id=None):
|
|
self.revoke(
|
|
model.RevokeEvent(user_id=user_id,
|
|
role_id=role_id,
|
|
domain_id=domain_id,
|
|
project_id=project_id))
|
|
|
|
def revoke_by_user_and_project(self, user_id, project_id):
|
|
self.revoke(
|
|
model.RevokeEvent(project_id=project_id, user_id=user_id))
|
|
|
|
def revoke_by_project_role_assignment(self, project_id, role_id):
|
|
self.revoke(model.RevokeEvent(project_id=project_id, role_id=role_id))
|
|
|
|
def revoke_by_domain_role_assignment(self, domain_id, role_id):
|
|
self.revoke(model.RevokeEvent(domain_id=domain_id, role_id=role_id))
|
|
|
|
@MEMOIZE
|
|
def _get_revoke_tree(self):
|
|
events = self.driver.list_events()
|
|
revoke_tree = model.RevokeTree(revoke_events=events)
|
|
|
|
return revoke_tree
|
|
|
|
def check_token(self, token_values):
|
|
"""Checks the values from a token against the revocation list
|
|
|
|
:param token_values: dictionary of values from a token, normalized for
|
|
differences between v2 and v3. The checked values
|
|
are a subset of the attributes of model.TokenEvent
|
|
|
|
:raises keystone.exception.TokenNotFound: If the token is invalid.
|
|
|
|
"""
|
|
if self._get_revoke_tree().is_revoked(token_values):
|
|
raise exception.TokenNotFound(_('Failed to validate token'))
|
|
|
|
def revoke(self, event):
|
|
self.driver.revoke(event)
|
|
self._get_revoke_tree.invalidate(self)
|
|
|
|
|
|
@six.add_metaclass(abc.ABCMeta)
|
|
class RevokeDriverV8(object):
|
|
"""Interface for recording and reporting revocation events."""
|
|
|
|
@abc.abstractmethod
|
|
def list_events(self, last_fetch=None):
|
|
"""return the revocation events, as a list of objects
|
|
|
|
:param last_fetch: Time of last fetch. Return all events newer.
|
|
:returns: A list of keystone.revoke.model.RevokeEvent
|
|
newer than `last_fetch.`
|
|
If no last_fetch is specified, returns all events
|
|
for tokens issued after the expiration cutoff.
|
|
|
|
"""
|
|
raise exception.NotImplemented() # pragma: no cover
|
|
|
|
@abc.abstractmethod
|
|
def revoke(self, event):
|
|
"""register a revocation event
|
|
|
|
:param event: An instance of
|
|
keystone.revoke.model.RevocationEvent
|
|
|
|
"""
|
|
raise exception.NotImplemented() # pragma: no cover
|
|
|
|
|
|
Driver = manager.create_legacy_driver(RevokeDriverV8)
|