EntityCategory::process() - Code Metrics - simplesamlphp/simplesamlphp-module-entitycategories - Measure and Improve Code Quality continuously with Scrutinizer

EntityCategory::process() D
last analyzed 2025-07-21 17:05 UTC

↳ Parent: EntityCategory

Complexity

Conditions	18
Paths	23

Size

Total Lines	62
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	18
eloc	34
c	1
b	0
f	0
nc	23
nop	1
dl	0
loc	62
rs	4.8666

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\entitycategories\Auth\Process;

use SimpleSAML\Assert\Assert;
use SimpleSAML\Auth;
use SimpleSAML\Error;

use function array_key_exists;
use function array_merge;
use function in_array;
use function is_numeric;

/**
 * An authentication processing filter that modifies the list of attributes sent to a service depending on the entity
 * categories it belongs to. This filter DOES NOT alter the list of attributes sent itself, but modifies the list of
 * attributes requested by the service provider. Therefore, in order to be of any use, it must be used together with the
 * core:AttributeLimit authentication processing filter.
 *
 * @package SimpleSAMLphp
 */
class EntityCategory extends Auth\ProcessingFilter
{
    /**
     * A list of categories available. An associative array where the identifier of the category is the key, and the
     * associated value is an array with all the attributes allowed for services in that category.
     *
     * @var array
     */
    protected array $categories = [];

    /**
     * Whether the attributes allowed by this category should be sent by default in case no attributes are explicitly
     * requested or not.
     *
     * @var bool
     */
    protected bool $default = false;

    /**
     *
     * Whether it is allowed to release attributes to entities having no entity category or
     * having unconfigured entity categories
     * Strict means not to release attributes to that entities. If strict is false, attributeLimit will do the filtering
     *
     * @var bool
     */
    protected bool $strict = false;

    /**
     *
     * Whether it is allowed to release additional requested attributes than configured in the list of the
     * configuration of the entity category and allow release attributes based on requested attributes to entities
     * having unconfigured entity categories.
     *
     * @var bool
     */
    protected bool $allowRequestedAttributes = false;


    /**
     * EntityCategory constructor.
     *
     * @param array $config An array with the configuration for this processing filter.
     * @param mixed $reserved For future use.
     * @throws \SimpleSAML\Error\ConfigurationError In case of a misconfiguration of the filter.
     */
    public function __construct(array $config, $reserved)
    {
        parent::__construct($config, $reserved);

        foreach ($config as $index => $value) {
            if ($index === 'default') {
                Assert::boolean(
                    $value,
                    "The 'default' configuration option must have a boolean value.",
                    Error\ConfigurationError::class,
                );
                $this->default = $value;
                continue;
            }

            if ($index === 'strict') {
                Assert::boolean(
                    $value,
                    "The 'strict' configuration option must have a boolean value.",
                    Error\ConfigurationError::class,
                );
                $this->strict = $value;
                continue;
            }

            if ($index === 'allowRequestedAttributes') {
                Assert::boolean(
                    $value,
                    "The 'allowRequestedAttributes' configuration option must have a boolean value.",
                    Error\ConfigurationError::class,
                );
                $this->allowRequestedAttributes = $value;
                continue;
            }

            Assert::string(
                $index,
                "Identifier of a category must be a string. '$index' is set.",
                Error\ConfigurationError::class,
            );

            Assert::isArray(
                $value,
                "The list of allowed attributes for category '$index' is not an array.",
                Error\ConfigurationError::class,
            );

            $this->categories[$index] = $value;
        }
    }


    /**
     * Apply the filter to modify the list of attributes for the current service provider.
     *
     * @param array &$state The current request.
     */
    public function process(array &$state): void
    {
        if (!array_key_exists('EntityAttributes', $state['Destination'])) {
            if ($this->strict === true) {
                // We do not allow to release any attribute to entity having no entity attribute
                $state['Destination']['attributes'] = [];
            }
            return;
        }

        if (!array_key_exists('http://macedir.org/entity-category', $state['Destination']['EntityAttributes'])) {
            if ($this->strict === true) {
                // We do not allow to release any attribute to entity having no entity category
                $state['Destination']['attributes'] = [];
            }
            return;
        }
        $categories = $state['Destination']['EntityAttributes']['http://macedir.org/entity-category'];

        if (!array_key_exists('attributes', $state['Destination'])) {
            if ($this->default === true) {
                // handle the case of service providers requesting no attributes and the filter being the default policy
                $state['Destination']['attributes'] = [];
                foreach ($categories as $category) {
                    if (!array_key_exists($category, $this->categories)) {
                        continue;
                    }

                    $state['Destination']['attributes'] = array_merge(
                        $state['Destination']['attributes'],
                        $this->categories[$category],
                    );
                }
            }
            return;
        }

        // iterate over the requested attributes and see if any of the categories allows them
        foreach ($state['Destination']['attributes'] as $index => $value) {
            $attrname = $value;
            if (!is_numeric($index)) {
                $attrname = $index;
            }

            $found = false;
            foreach ($categories as $category) {
                if (!array_key_exists($category, $this->categories)) {
                    continue;
                }

                if (
                    in_array($attrname, $this->categories[$category], true)
                    || $this->allowRequestedAttributes === true
                ) {
                    $found = true;
                    break;
                }
            }

            if ($found === false && ($this->allowRequestedAttributes === false || $this->strict === true)) {
                // no category (if any) allows the attribute, so remove it
                unset($state['Destination']['attributes'][$index]);
            }
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\Module\entitycategories\Auth\Process;
6
7			use SimpleSAML\Assert\Assert;
8			use SimpleSAML\Auth;
9			use SimpleSAML\Error;
10
11			use function array_key_exists;
12			use function array_merge;
13			use function in_array;
14			use function is_numeric;
15
16			/**
17			* An authentication processing filter that modifies the list of attributes sent to a service depending on the entity
18			* categories it belongs to. This filter DOES NOT alter the list of attributes sent itself, but modifies the list of
19			* attributes requested by the service provider. Therefore, in order to be of any use, it must be used together with the
20			* core:AttributeLimit authentication processing filter.
21			*
22			* @package SimpleSAMLphp
23			*/
24			class EntityCategory extends Auth\ProcessingFilter
25			{
26			/**
27			* A list of categories available. An associative array where the identifier of the category is the key, and the
28			* associated value is an array with all the attributes allowed for services in that category.
29			*
30			* @var array
31			*/
32			protected array $categories = [];
33
34			/**
35			* Whether the attributes allowed by this category should be sent by default in case no attributes are explicitly
36			* requested or not.
37			*
38			* @var bool
39			*/
40			protected bool $default = false;
41
42			/**
43			*
44			* Whether it is allowed to release attributes to entities having no entity category or
45			* having unconfigured entity categories
46			* Strict means not to release attributes to that entities. If strict is false, attributeLimit will do the filtering
47			*
48			* @var bool
49			*/
50			protected bool $strict = false;
51
52			/**
53			*
54			* Whether it is allowed to release additional requested attributes than configured in the list of the
55			* configuration of the entity category and allow release attributes based on requested attributes to entities
56			* having unconfigured entity categories.
57			*
58			* @var bool
59			*/
60			protected bool $allowRequestedAttributes = false;
61
62
63			/**
64			* EntityCategory constructor.
65			*
66			* @param array $config An array with the configuration for this processing filter.
67			* @param mixed $reserved For future use.
68			* @throws \SimpleSAML\Error\ConfigurationError In case of a misconfiguration of the filter.
69			*/
70			public function __construct(array $config, $reserved)
71			{
72			parent::__construct($config, $reserved);
73
74			foreach ($config as $index => $value) {
75			if ($index === 'default') {
76			Assert::boolean(
77			$value,
78			"The 'default' configuration option must have a boolean value.",
79			Error\ConfigurationError::class,
80			);
81			$this->default = $value;
82			continue;
83			}
84
85			if ($index === 'strict') {
86			Assert::boolean(
87			$value,
88			"The 'strict' configuration option must have a boolean value.",
89			Error\ConfigurationError::class,
90			);
91			$this->strict = $value;
92			continue;
93			}
94
95			if ($index === 'allowRequestedAttributes') {
96			Assert::boolean(
97			$value,
98			"The 'allowRequestedAttributes' configuration option must have a boolean value.",
99			Error\ConfigurationError::class,
100			);
101			$this->allowRequestedAttributes = $value;
102			continue;
103			}
104
105			Assert::string(
106			$index,
107			"Identifier of a category must be a string. '$index' is set.",
108			Error\ConfigurationError::class,
109			);
110
111			Assert::isArray(
112			$value,
113			"The list of allowed attributes for category '$index' is not an array.",
114			Error\ConfigurationError::class,
115			);
116
117			$this->categories[$index] = $value;
118			}
119			}
120
121
122			/**
123			* Apply the filter to modify the list of attributes for the current service provider.
124			*
125			* @param array &$state The current request.
126			*/
127			public function process(array &$state): void
128			{
129			if (!array_key_exists('EntityAttributes', $state['Destination'])) {
130			if ($this->strict === true) {
131			// We do not allow to release any attribute to entity having no entity attribute
132			$state['Destination']['attributes'] = [];
133			}
134			return;
135			}
136
137			if (!array_key_exists('http://macedir.org/entity-category', $state['Destination']['EntityAttributes'])) {
138			if ($this->strict === true) {
139			// We do not allow to release any attribute to entity having no entity category
140			$state['Destination']['attributes'] = [];
141			}
142			return;
143			}
144			$categories = $state['Destination']['EntityAttributes']['http://macedir.org/entity-category'];
145
146			if (!array_key_exists('attributes', $state['Destination'])) {
147			if ($this->default === true) {
148			// handle the case of service providers requesting no attributes and the filter being the default policy
149			$state['Destination']['attributes'] = [];
150			foreach ($categories as $category) {
151			if (!array_key_exists($category, $this->categories)) {
152			continue;
153			}
154
155			$state['Destination']['attributes'] = array_merge(
156			$state['Destination']['attributes'],
157			$this->categories[$category],
158			);
159			}
160			}
161			return;
162			}
163
164			// iterate over the requested attributes and see if any of the categories allows them
165			foreach ($state['Destination']['attributes'] as $index => $value) {
166			$attrname = $value;
167			if (!is_numeric($index)) {
168			$attrname = $index;
169			}
170
171			$found = false;
172			foreach ($categories as $category) {
173			if (!array_key_exists($category, $this->categories)) {
174			continue;
175			}
176
177			if (
178			in_array($attrname, $this->categories[$category], true)
179			\|\| $this->allowRequestedAttributes === true
180			) {
181			$found = true;
182			break;
183			}
184			}
185
186			if ($found === false && ($this->allowRequestedAttributes === false \|\| $this->strict === true)) {
187			// no category (if any) allows the attribute, so remove it
188			unset($state['Destination']['attributes'][$index]);
189			}
190			}
191			}
192			}
193

simplesamlphp / simplesamlphp-module-entitycategories

EntityCategory::process() D last analyzed 2025-07-21 17:05 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

EntityCategory::process() D
last analyzed 2025-07-21 17:05 UTC