octavia/octavia/common/keystone.py

81 lines
2.6 KiB
Python

# Copyright 2015 Rackspace
#
# 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.
from keystoneauth1 import loading as ks_loading
from keystonemiddleware import auth_token
from oslo_config import cfg
from oslo_log import log as logging
from octavia.common import constants
LOG = logging.getLogger(__name__)
_NOAUTH_PATHS = ['/', '/load-balancer/', '/healthcheck',
'/load-balancer/healthcheck']
class KeystoneSession(object):
def __init__(self, section=constants.SERVICE_AUTH):
self._session = None
self._auth = None
self.section = section
ks_loading.register_auth_conf_options(cfg.CONF, self.section)
ks_loading.register_session_conf_options(cfg.CONF, self.section)
def get_session(self):
"""Initializes a Keystone session.
:return: a Keystone Session object
"""
if not self._session:
self._session = ks_loading.load_session_from_conf_options(
cfg.CONF, self.section, auth=self.get_auth())
return self._session
def get_auth(self):
if not self._auth:
self._auth = ks_loading.load_auth_from_conf_options(
cfg.CONF, self.section)
return self._auth
def get_service_user_id(self):
return self.get_auth().get_user_id(self.get_session())
class SkippingAuthProtocol(auth_token.AuthProtocol):
"""SkippingAuthProtocol to reach special endpoints
Bypasses keystone authentication for special request paths, such
as the api version discovery path.
Note:
SkippingAuthProtocol is lean customization
of :py:class:`keystonemiddleware.auth_token.AuthProtocol`
that disables keystone communication if the request path
is in the _NOAUTH_PATHS list.
"""
def process_request(self, request):
path = request.path
if path in _NOAUTH_PATHS:
LOG.debug('Request path is %s and it does not require keystone '
'authentication', path)
return None # return NONE to reach actual logic
return super(SkippingAuthProtocol, self).process_request(request)