OpenConext\Profile\Entity\AuthenticatedUser

Complexity

Total Complexity

11

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	createFrom()	0	20	3
A	__construct()	0	9	1
A	getNameId()	0	4	1
A	getAttributes()	0	4	1
A	getAuthenticatingAuthorities()	0	4	1
A	__toString()	0	4	1
A	getAttributesFiltered()	0	14	3

<?php

/**
 * Copyright 2015 SURFnet B.V.
 *
 * 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.
 */

namespace OpenConext\Profile\Entity;

use OpenConext\Profile\Assert;
use OpenConext\Profile\Exception\RuntimeException;
use OpenConext\Profile\Value\EntityId;
use Surfnet\SamlBundle\SAML2\Attribute\Attribute;
use Surfnet\SamlBundle\SAML2\Attribute\AttributeSet;
use Surfnet\SamlBundle\SAML2\Response\AssertionAdapter;

final class AuthenticatedUser
{
    /**
     * @var string
     */
    private $nameId;

    /**
     * @var AttributeSet
     */
    private $attributes;

    /**
     * @var EntityId[]
     */
    private $authenticatingAuthorities;

    /**
     * A list of blacklisted attributes defined by their Urn OID
     * @var array
     */
    private static $blacklistedAttributes = [
        'urn:oid:1.3.6.1.4.1.1076.20.40.40.1',
        'urn:oid:1.3.6.1.4.1.1466.115.121.1.15',
    ];

    /**
     * @param AssertionAdapter $assertionAdapter
     * @param EntityId[] $authenticatingAuthorities
     *
     * @return AuthenticatedUser
     * @throws RuntimeException
     */
    public static function createFrom(AssertionAdapter $assertionAdapter, array $authenticatingAuthorities)
    {
        $attributes = [];

        /** @var Attribute $attribute */
        foreach ($assertionAdapter->getAttributeSet() as $attribute) {
            $definition = $attribute->getAttributeDefinition();

            // We only want to replace the eduPersonTargetedID attribute value as that is a nested NameID attribute
            if ($definition->getName() !== 'eduPersonTargetedID') {
                $attributes[] = $attribute;
                continue;
            }

            $eptiValues = $attribute->getValue();
            $attributes[] = new Attribute($definition, [$eptiValues[0]->value]);
        }

        return new self($assertionAdapter->getNameId(), AttributeSet::create($attributes), $authenticatingAuthorities);
    }

    /**
     * @param string $nameId
     * @param AttributeSet $attributes
     * @param EntityId[] $authenticatingAuthorities
     */
    private function __construct($nameId, AttributeSet $attributes, array $authenticatingAuthorities)
    {
        Assert::string($nameId);
        Assert::allIsInstanceOf($authenticatingAuthorities, '\OpenConext\Profile\Value\EntityId');

        $this->nameId                    = $nameId;
        $this->attributes                = $attributes;
        $this->authenticatingAuthorities = $authenticatingAuthorities;
    }

    /**
     * @return string
     */
    public function getNameId()
    {
        return $this->nameId;
    }

    /**
     * @return AttributeSet
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * @return EntityId[]
     */
    public function getAuthenticatingAuthorities()
    {
        return $this->authenticatingAuthorities;
    }

    /**
     * Using toString in order to comply with AbstractToken's setUser method,
     * which uses the string representation to detect changes in the user object.
     * Not implementing a UserInterface, because methods defined there will not be used.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->nameId;
    }

    /**
     * @return AttributeSet
     */
    public function getAttributesFiltered()
    {
        $attributes = $this->getAttributes();
        $filtered = [];
        /** @var Attribute $attribute */
        foreach ($attributes as $attribute) {
            // Filter out blacklisted attributes
            if (in_array($attribute->getAttributeDefinition()->getUrnOid(), self::$blacklistedAttributes)) {
                continue;
            }
            $filtered[] = $attribute;
        }
        return AttributeSet::create($filtered);
    }
}