Cardinality.php

Go to the documentation of this file.

<?php

use SimpleSAML\Utils\HTTPAdapter;

class sspmod_core_Auth_Process_Cardinality extends SimpleSAML_Auth_ProcessingFilter
{
    private $cardinality = array();

    private $ignoreEntities = array();

    private $http;

    public function __construct($config, $reserved, HTTPAdapter $http = null)
    {
        parent::__construct($config, $reserved);
        assert(is_array($config));

        $this->http = $http ?: new HTTPAdapter();

        foreach ($config as $attribute => $rules) {
            if ($attribute === '%ignoreEntities') {
                $this->ignoreEntities = $config['%ignoreEntities'];
                continue;
            }

            if (!is_string($attribute)) {
                throw new SimpleSAML_Error_Exception('Invalid attribute name: '.var_export($attribute, true));
            }
            $this->cardinality[$attribute] = array('warn' => false);

            /* allow either positional or name-based parameters */
            if (isset($rules[0])) {
                $this->cardinality[$attribute]['min'] = $rules[0];
            } elseif (isset($rules['min'])) {
                $this->cardinality[$attribute]['min'] = $rules['min'];
            }
            if (isset($rules[1])) {
                $this->cardinality[$attribute]['max'] = $rules[1];
            } elseif (isset($rules['max'])) {
                $this->cardinality[$attribute]['max'] = $rules['max'];
            }
            if (array_key_exists('warn', $rules)) {
                $this->cardinality[$attribute]['warn'] = (bool) $rules['warn'];
            }

            /* sanity check the rules */
            if (!array_key_exists('min', $this->cardinality[$attribute])) {
                $this->cardinality[$attribute]['min'] = 0;
            } elseif (!is_int($this->cardinality[$attribute]['min']) ||
                $this->cardinality[$attribute]['min'] < 0
            ) {
                throw new SimpleSAML_Error_Exception('Minimum cardinality must be a positive integer: '.
                    var_export($attribute, true));
            }
            if (array_key_exists('max', $this->cardinality[$attribute]) &&
                !is_int($this->cardinality[$attribute]['max'])
            ) {
                throw new SimpleSAML_Error_Exception('Maximum cardinality must be a positive integer: '.
                    var_export($attribute, true));
            }
            if (array_key_exists('min', $this->cardinality[$attribute]) &&
                array_key_exists('max', $this->cardinality[$attribute]) &&
                $this->cardinality[$attribute]['min'] > $this->cardinality[$attribute]['max']
            ) {
                throw new SimpleSAML_Error_Exception('Minimum cardinality must be less than maximium: '.
                    var_export($attribute, true));
            }

            /* generate a display expression */
            $this->cardinality[$attribute]['_expr'] = sprintf('%d ≤ n', $this->cardinality[$attribute]['min']);
            if (array_key_exists('max', $this->cardinality[$attribute])) {
                $this->cardinality[$attribute]['_expr'] .= sprintf(' ≤ %d', $this->cardinality[$attribute]['max']);
            }
        }
    }

    public function process(&$request)
    {
        assert(is_array($request));
        assert(array_key_exists("Attributes", $request));

        $entityid = false;
        if (array_key_exists('Source', $request) && array_key_exists('entityid', $request['Source'])) {
            $entityid = $request['Source']['entityid'];
        }
        if (in_array($entityid, $this->ignoreEntities, true)) {
            SimpleSAML\Logger::debug('Cardinality: Ignoring assertions from '.$entityid);
            return;
        }

        foreach ($request['Attributes'] as $k => $v) {

            if (!array_key_exists($k, $this->cardinality)) {
                continue;
            }
            if (!is_array($v)) {
                $v = array($v);
            }

            /* minimum cardinality */
            if (count($v) < $this->cardinality[$k]['min']) {
                if ($this->cardinality[$k]['warn']) {
                    SimpleSAML\Logger::warning(sprintf(
                        'Cardinality: attribute %s from %s does not meet minimum cardinality of %d (%d)',
                        $k, $entityid, $this->cardinality[$k]['min'], count($v)
                    ));
                } else {
                    $request['core:cardinality:errorAttributes'][$k] = array(count($v), $this->cardinality[$k]['_expr']);
                }
                continue;
            }

            /* maximum cardinality */
            if (array_key_exists('max', $this->cardinality[$k]) && count($v) > $this->cardinality[$k]['max']) {
                if ($this->cardinality[$k]['warn']) {
                    SimpleSAML\Logger::warning(sprintf(
                        'Cardinality: attribute %s from %s does not meet maximum cardinality of %d (%d)',
                        $k, $entityid, $this->cardinality[$k]['max'], count($v)
                    ));
                } else {
                    $request['core:cardinality:errorAttributes'][$k] = array(count($v), $this->cardinality[$k]['_expr']);
                }
                continue;
            }
        }

        /* check for missing attributes with a minimum cardinality */
        foreach ($this->cardinality as $k => $v) {
            if (!$this->cardinality[$k]['min'] || array_key_exists($k, $request['Attributes'])) {
                continue;
            }
            if ($this->cardinality[$k]['warn']) {
                SimpleSAML\Logger::warning(sprintf(
                    'Cardinality: attribute %s from %s is missing',
                    $k, $entityid
                ));
            } else {
                $request['core:cardinality:errorAttributes'][$k] = array(0, $this->cardinality[$k]['_expr']);
            }
        }

        /* abort if we found a problematic attribute */
        if (array_key_exists('core:cardinality:errorAttributes', $request)) {
            $id = SimpleSAML_Auth_State::saveState($request, 'core:cardinality');
            $url = SimpleSAML\Module::getModuleURL('core/cardinality_error.php');
            $this->http->redirectTrustedURL($url, array('StateId' => $id));
            return;
        }
    }
}