AbstractProvider - Code Metrics - Inspection of "Added NameID Override per IDP to the SP templates." - flipboxfactory/saml-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 72ecff...582962 )

by Damien

created 2020-09-23 04:52 UTC

AbstractProvider A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	268
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

Metric	Value
wmc	33
lcom	1
cbo	12
dl	0
loc	268
rs	9.76
c	0
b	0
f	0

23 Methods

Rating	Name	Size	Complexity
A	hasMapping()	4	1
A	hasGroupOptions()	4	1
	getLoginPath()	1	?
	getLogoutPath()	1	?
A	loadDefaultValues()	11	2
A	isIdentityProvider()	4	1
A	isServiceProvider()	4	1
A	setMapping()	6	1
A	getMapping()	9	2
A	setMetadataOptions()	6	1
A	getMetadataOptions()	9	2
A	setGroupOptions()	6	1
A	getGroupOptions()	9	2
A	hasMetadataOptions()	4	1
A	hasJsonProperty()	12	3
A	beforeSave()	24	5
A	getEntityId()	5	1
A	getMetadataModel()	11	3
A	setMetadataModel()	5	1
A	getType()	4	1
A	getLink()	6	1
A	getKeychain()	8	1
A	setKeychain()	5	1

<?php

namespace flipbox\saml\core\records;

use craft\db\ActiveRecord;
use craft\helpers\StringHelper;
use flipbox\keychain\records\KeyChainRecord;
use flipbox\saml\core\models\GroupOptions;
use flipbox\saml\core\models\MetadataOptions;
use flipbox\saml\core\records\traits\Ember;
use SAML2\DOMDocumentFactory;
use SAML2\XML\md\EntityDescriptor;
use yii\db\ActiveQuery;

/**
 * Class AbstractProvider
 * @package flipbox\saml\core\records
 */
abstract class AbstractProvider extends ActiveRecord implements ProviderInterface
{

    use traits\EntityDescriptor, traits\KeyChain, traits\MapUser, Ember;

    const METADATA_HASH_ALGORITHM = 'sha256';
    const DEFAULT_GROUPS_ATTRIBUTE_NAME = 'groups';

    protected $metadataModel;
    protected $cachedKeychain;

    /**
     * This method helps initiate the login process for a remote provider.
     * When using this method, say your craft site is the SP. This method will be helpful
     * on the IDP provider record. Going to this login path will
     * initiate the login process for this IDP. Returns null when you getLoginPath for the
     * local provider (the current craft site).
     *
     * @return string|null
     */
    abstract public function getLoginPath();

    /**
     * Similar to getLoginPath(), this method initiates logout with the intended remote
     * provider.
     *
     * @return string|null
     */
    abstract public function getLogoutPath();


    /**
     * @inheritDoc
     */
    public function loadDefaultValues($skipIfSet = true)
    {
        parent::loadDefaultValues($skipIfSet);

        // fix the issue with postgres pulling zero as default
        if (!trim($this->uid)) {
            $this->uid = StringHelper::UUID();
        }

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function beforeSave($insert)
    {
        if (! $this->entityId) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->entityId = $this->getEntityId();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        if (is_array($this->mapping)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->mapping = json_encode($this->mapping);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        if ($this->groupOptions instanceof GroupOptions) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->groupOptions = json_encode($this->groupOptions);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        if ($this->metadataOptions instanceof MetadataOptions) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->metadataOptions = json_encode($this->metadataOptions);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        $this->sha256 = hash(static::METADATA_HASH_ALGORITHM, $this->metadata);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $this->metadata = $this->getMetadataModel()->toXML()->ownerDocument->saveXML();


        return parent::beforeSave($insert);
    }

    /**
     * @return string
     */
    public function getEntityId()
    {
        $metadata = $this->getMetadataModel();
        return $metadata->getEntityID();
    }

    /**
     * @return EntityDescriptor
     */
    public function getMetadataModel()
    {

        if (! $this->metadataModel && $this->metadata) {

            $this->metadataModel = new EntityDescriptor(
                DOMDocumentFactory::fromString($this->metadata)->documentElement

            );
        }

        return $this->metadataModel;
    }

    /**
     * @param EntityDescriptor $descriptor
     * @return $this
     */
    public function setMetadataModel(EntityDescriptor $descriptor)
    {
        $this->metadataModel = $descriptor;
        return $this;
    }

    /**
     * @return bool
     */
    public function isIdentityProvider()
    {
        return $this->providerType === static::TYPE_IDP;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * @return bool
     */
    public function isServiceProvider()
    {
        return $this->providerType === static::TYPE_SP;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * @return string
     */
    public function getType()
    {
        return $this->providerType;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * @return ActiveQuery
     */
    public function getLink()
    {
        return $this->hasOne(LinkRecord::class, [
            'providerId' => 'id',
        ]);
    }

    /**
     * @return ActiveQuery
     */
    public function getKeychain()
    {
        return $this->hasOne(KeyChainRecord::class, [
            'id' => 'keyChainId',
        ])->viaTable(LinkRecord::tableName(), [
            'providerId' => 'id',
        ]);
    }

    /**
     * @param KeyChainRecord $keyChain
     * @return AbstractProvider
     */
    public function setKeychain(KeyChainRecord $keyChain)
    {
        $this->populateRelation('keychain', $keyChain);
        return $this;
    }

    /**
     * @param array $mapping
     * @return $this
     */
    public function setMapping(array $mapping)
    {
        $this->mapping = array_values($mapping);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $this;
    }

    /**
     * @return array
     */
    public function getMapping()
    {
        $mapping = [];
        if ($this->hasMapping()) {
            $mapping = json_decode($this->mapping, true);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return $mapping;
    }

    public function setMetadataOptions(MetadataOptions $metadataOptions)
    {
        $this->metadataOptions = $metadataOptions;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $this;
    }

    public function getMetadataOptions(): MetadataOptions
    {
        $metadataOptions = new MetadataOptions();
        if ($this->hasMetadataOptions()) {
            $metadataOptions = MetadataOptions::jsonUnserialize($this->metadataOptions);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return $metadataOptions;
    }

    /**
     * @param GroupOptions $groupOptions
     * @return $this
     */
    public function setGroupOptions(GroupOptions $groupOptions)
    {
        $this->groupOptions = $groupOptions;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $this;
    }

    public function getGroupOptions(): GroupOptions
    {
        $groupOptions = new GroupOptions();
        if ($this->hasGroupOptions()) {
            $groupOptions = GroupOptions::jsonUnserialize($this->groupOptions);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return $groupOptions;
    }


    /**
     * @return bool
     */
    public function hasMapping()
    {
        return $this->hasJsonProperty('mapping');
    }

    /**
     * @return bool
     */
    public function hasGroupOptions(): bool
    {
        return $this->hasJsonProperty('groupOptions');
    }

    /**
     * @return bool
     */
    public function hasMetadataOptions(): bool
    {
        return $this->hasJsonProperty('metadataOptions');
    }

    /**
     * @param string $property
     * @return bool
     */
    protected function hasJsonProperty(string $property)
    {
        if (! $this->{$property}) {
            return false;
        }
        try {
            json_decode($this->{$property}, true);
            return true;
        } catch (\Exception $e) {
            return false;
        }
    }
}


1			<?php
2
3			namespace flipbox\saml\core\records;
4
5			use craft\db\ActiveRecord;
6			use craft\helpers\StringHelper;
7			use flipbox\keychain\records\KeyChainRecord;
8			use flipbox\saml\core\models\GroupOptions;
9			use flipbox\saml\core\models\MetadataOptions;
10			use flipbox\saml\core\records\traits\Ember;
11			use SAML2\DOMDocumentFactory;
12			use SAML2\XML\md\EntityDescriptor;
13			use yii\db\ActiveQuery;
14
15			/**
16			* Class AbstractProvider
17			* @package flipbox\saml\core\records
18			*/
19			abstract class AbstractProvider extends ActiveRecord implements ProviderInterface
20			{
21
22			use traits\EntityDescriptor, traits\KeyChain, traits\MapUser, Ember;
23
24			const METADATA_HASH_ALGORITHM = 'sha256';
25			const DEFAULT_GROUPS_ATTRIBUTE_NAME = 'groups';
26
27			protected $metadataModel;
28			protected $cachedKeychain;
29
30			/**
31			* This method helps initiate the login process for a remote provider.
32			* When using this method, say your craft site is the SP. This method will be helpful
33			* on the IDP provider record. Going to this login path will
34			* initiate the login process for this IDP. Returns null when you getLoginPath for the
35			* local provider (the current craft site).
36			*
37			* @return string\|null
38			*/
39			abstract public function getLoginPath();
40

flipboxfactory / saml-core

Push — master ( 72ecff...582962 )

AbstractProvider A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

23 Methods

Duplication Side-by-Side

Filter issues like