sspmod_casserver_Cas_AttributeExtractor

Complexity

Total Complexity

8

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	invokeAuthProc()	0	18	2
A	extractUserAndAttributes()	0	32	6

<?php

use SimpleSAML\Configuration;
use SimpleSAML\Module;

/**
 * Extract the user and any mapped attributes from the AuthSource attributes
 */
class sspmod_casserver_Cas_AttributeExtractor
{

    /**
     * Determine the user and any CAS attributes based on the attributes from the
     * authsource and the CAS configuration.
     *
     * The result is an array
     * [
     *   'user' => 'user_value',
     *   'attributes' => [
     *    // any attributes
     * ]
     *
     * If no CAS attributes are configured then the attributes array is empty
     * @param array $attributes
     * @param \SimpleSAML\Configuration $casconfig
     * @return array
     */
    public function extractUserAndAttributes(array $attributes, Configuration $casconfig)
    {
        if ($casconfig->hasValue('authproc')) {
            $attributes = $this->invokeAuthProc($attributes, $casconfig);
        }

        $casUsernameAttribute = $casconfig->getValue('attrname', 'eduPersonPrincipalName');

        //TODO: how should a missing userName be handled?
        $userName = $attributes[$casUsernameAttribute][0];

        if ($casconfig->getValue('attributes', true)) {
            $attributesToTransfer = $casconfig->getValue('attributes_to_transfer', []);

            if (sizeof($attributesToTransfer) > 0) {
                $casAttributes = array();

                foreach ($attributesToTransfer as $key) {
                    if (array_key_exists($key, $attributes)) {
                        $casAttributes[$key] = $attributes[$key];
                    }
                }
            } else {
                $casAttributes = $attributes;
            }
        } else {
            $casAttributes = [];
        }

        return array(
            'user' => $userName,
            'attributes' => $casAttributes
        );
    }

    /**
     * Process any authproc filters defined in the configuration. The Authproc filters must only
     * rely on 'Attributes' being available and not on additional SAML state
     * @param array $attributes The current attributes
     * @param \SimpleSAML\Configuration $casconfig The cas configuration
     * @return array The attributes post processing.
     */
    private function invokeAuthProc(array $attributes, Configuration $casconfig)
    {
        $filters = $casconfig->getArray('authproc', []);

        $state = array(
            'Attributes' => $attributes
        );
        foreach ($filters as $config) {
            $className = Module::resolveClass(
                $config['class'],
                'Auth\Process',
                \SimpleSAML\Auth\ProcessingFilter::class
            );
            $filter = new $className($config, null);
            $filter->process($state);
        }

        return $state['Attributes'];
    }
}