text: # 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 functools
  
  from oslo.serialization import jsonutils
  from pycadf import cadftaxonomy as taxonomy
  from six.moves.urllib import parse
  
  from keystone import auth
  from keystone.common import dependency
  from keystone.contrib import federation
  from keystone.contrib.federation import utils
  from keystone import exception
  from keystone.i18n import _
  from keystone.models import token_model
  from keystone import notifications
  from keystone.openstack.common import log
  
  
  LOG = log.getLogger(__name__)
  
  
  @dependency.requires('federation_api', 'identity_api', 'token_provider_api')
  class Mapped(auth.AuthMethodHandler):
  
      def authenticate(self, context, auth_payload, auth_context):
          """Authenticate mapped user and return an authentication context.
  
          :param context: keystone's request context
          :param auth_payload: the content of the authentication for a
                               given method
          :param auth_context: user authentication context, a dictionary
                               shared by all plugins.
  
          In addition to ``user_id`` in ``auth_context``, this plugin sets
          ``group_ids``, ``OS-FEDERATION:identity_provider`` and
          ``OS-FEDERATION:protocol``
          """
  
          if 'id' in auth_payload:
              fields = self._handle_scoped_token(context, auth_payload)
          else:
              fields = self._handle_unscoped_token(context, auth_payload)
  
          auth_context.update(fields)
  
      def _handle_scoped_token(self, context, auth_payload):
          token_id = auth_payload['id']
          token_ref = token_model.KeystoneToken(
              token_id=token_id,
              token_data=self.token_provider_api.validate_token(
                  token_id))
          utils.validate_expiration(token_ref)
          token_audit_id = token_ref.audit_id
          identity_provider = token_ref.federation_idp_id
          protocol = token_ref.federation_protocol_id
          user_id = token_ref.user_id
          group_ids = token_ref.federation_group_ids
          send_notification = functools.partial(
              notifications.send_saml_audit_notification, 'authenticate',
              context, user_id, group_ids, identity_provider, protocol,
              token_audit_id)
  
          try:
              mapping = self.federation_api.get_mapping_from_idp_and_protocol(
                  identity_provider, protocol)
              utils.validate_groups(group_ids, mapping['id'], self.identity_api)
  
          except Exception:
              # NOTE(topol): Diaper defense to catch any exception, so we can
              # send off failed authentication notification, raise the exception
              # after sending the notification
              send_notification(taxonomy.OUTCOME_FAILURE)
              raise
          else:
              send_notification(taxonomy.OUTCOME_SUCCESS)
          return {
              'user_id': user_id,
              'group_ids': group_ids,
              federation.IDENTITY_PROVIDER: identity_provider,
              federation.PROTOCOL: protocol
          }
  
      def _handle_unscoped_token(self, context, auth_payload):
          assertion = self._extract_assertion_data(context)
          identity_provider = auth_payload['identity_provider']
          protocol = auth_payload['protocol']
          group_ids = None
          # NOTE(topol): The user is coming in from an IdP with a SAML assertion
          # instead of from a token, so we set token_id to None
          token_id = None
          # NOTE(marek-denis): This variable is set to None and there is a
          # possibility that it will be used in the CADF notification. This means
          # operation will not be mapped to any user (even ephemeral).
          user_id = None
  
          try:
              mapped_properties = self._apply_mapping_filter(identity_provider,
                                                             protocol,
                                                             assertion)
              user_id = self._setup_username(context, mapped_properties)
              group_ids = mapped_properties['group_ids']
  
          except Exception:
              # NOTE(topol): Diaper defense to catch any exception, so we can
              # send off failed authentication notification, raise the exception
              # after sending the notification
              outcome = taxonomy.OUTCOME_FAILURE
              notifications.send_saml_audit_notification('authenticate', context,
                                                         user_id, group_ids,
                                                         identity_provider,
                                                         protocol, token_id,
                                                         outcome)
              raise
          else:
              outcome = taxonomy.OUTCOME_SUCCESS
              notifications.send_saml_audit_notification('authenticate', context,
                                                         user_id, group_ids,
                                                         identity_provider,
                                                         protocol, token_id,
                                                         outcome)
  
          return {
              'user_id': user_id,
              'group_ids': group_ids,
              federation.IDENTITY_PROVIDER: identity_provider,
              federation.PROTOCOL: protocol
          }
  
      def _extract_assertion_data(self, context):
          assertion = dict(utils.get_assertion_params_from_env(context))
          return assertion
  
      def _apply_mapping_filter(self, identity_provider, protocol, assertion):
          mapping = self.federation_api.get_mapping_from_idp_and_protocol(
              identity_provider, protocol)
          rules = jsonutils.loads(mapping['rules'])
          LOG.debug('using the following rules: %s', rules)
          rule_processor = utils.RuleProcessor(rules)
          mapped_properties = rule_processor.process(assertion)
          utils.validate_groups(mapped_properties['group_ids'],
                                mapping['id'], self.identity_api)
          return mapped_properties
  
      def _setup_username(self, context, mapped_properties):
          """Setup federated username.
  
          If ``user_name`` is specified in the mapping_properties use this
          value.Otherwise try fetching value from an environment variable
          ``REMOTE_USER``.
          This method also url encodes user_name and saves this value in user_id.
          If user_name cannot be mapped raise exception.Unauthorized.
  
          :param context: authentication context
          :param mapped_properties: Properties issued by a RuleProcessor.
          :type: dictionary
  
          :raises: exception.Unauthorized
          :returns: tuple with user_name and user_id values.
  
          """
          user_name = mapped_properties['name']
          if user_name is None:
              user_name = context['environment'].get('REMOTE_USER')
              if user_name is None:
                  raise exception.Unauthorized(_("Could not map user"))
          user_id = parse.quote(user_name)
          return user_id
  