flipbox\saml\core\helpers\EntityDescriptorHelper

Complexity

Total Complexity

23

Size/Duplication

Total Lines	235
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getIdpDescriptors()	0	4	1
A	getSpDescriptors()	0	4	1
A	getDescriptors()	0	11	3
A	getFirstArtifactResolutionService()	0	4	1
A	getFirstSLOService()	0	4	1
A	getFirstManageNameIDService()	0	4	1
A	getFirstSpAssertionConsumerService()	0	4	1
A	getFirstSpAttributeConsumingService()	0	4	1
A	getFirstIdpSSOService()	0	4	1
A	getFirstIdpAssertionIdRequestService()	0	4	1
A	getFirstIdpNameIDMappingService()	0	4	1
A	getFirstService()	0	35	4
B	getFirstIndexedEndpointType()	0	31	6

<?php


namespace flipbox\saml\core\helpers;

use flipbox\saml\core\AbstractPlugin;
use SAML2\XML\md\EndpointType;
use SAML2\XML\md\EntityDescriptor;
use SAML2\XML\md\IDPSSODescriptor;
use SAML2\XML\md\IndexedEndpointType;
use SAML2\XML\md\SPSSODescriptor;
use SAML2\XML\md\SSODescriptorType;

class EntityDescriptorHelper
{
    const ENDPOINT_SERVICE_ARTIFACT_RESOLUTION = 'ArtifactResolution';
    const ENDPOINT_SERVICE_SINGLE_LOGOUT = 'SingleLogout';
    const ENDPOINT_SERVICE_MANAGE_NAME_ID = 'ManageNameID';

    const ENDPOINT_SERVICE_ASSERTION_CONSUMER = 'AssertionConsumer';
    const ENDPOINT_SERVICE_ATTRIBUTE_CONSUMING = 'AttributeConsuming';

    const ENDPOINT_SERVICE_SINGLE_SIGN_ON = 'SingleSignOn';
    const ENDPOINT_SERVICE_ASSERTION_ID_REQUEST = 'AssertionIDRequest';
    const ENDPOINT_SERVICE_NAME_ID_MAPPING = 'NameIDMapping';

    const ENDPOINT_SERVICE_OPTIONS = [
        // Common
        self::ENDPOINT_SERVICE_ARTIFACT_RESOLUTION,
        self::ENDPOINT_SERVICE_SINGLE_LOGOUT,
        self::ENDPOINT_SERVICE_MANAGE_NAME_ID,

        // SP
        self::ENDPOINT_SERVICE_ASSERTION_CONSUMER,
        self::ENDPOINT_SERVICE_ATTRIBUTE_CONSUMING,

        // IDP
        self::ENDPOINT_SERVICE_SINGLE_SIGN_ON,
        self::ENDPOINT_SERVICE_ASSERTION_ID_REQUEST,
        self::ENDPOINT_SERVICE_NAME_ID_MAPPING,
    ];

    /**
     * @param EntityDescriptor $entityDescriptor
     * @return IDPSSODescriptor[]
     */
    public static function getIdpDescriptors(EntityDescriptor $entityDescriptor)
    {
        return static::getDescriptors($entityDescriptor, IDPSSODescriptor::class);
    }

    /**
     * @param EntityDescriptor $entityDescriptor
     * @return SPSSODescriptor[]
     */
    public static function getSpDescriptors(EntityDescriptor $entityDescriptor)
    {
        return static::getDescriptors($entityDescriptor, SPSSODescriptor::class);
    }

    /**
     * @param EntityDescriptor $entityDescriptor
     * @param string $type
     * @return SSODescriptorType[]
     */
    protected static function getDescriptors(EntityDescriptor $entityDescriptor, string $type)
    {
        $descriptors = [];
        foreach ($entityDescriptor->getRoleDescriptor() as $roleDescriptor) {
            if ($roleDescriptor instanceof $type) {
                $descriptors[] = $roleDescriptor;
            }
        }

        return $descriptors;
    }

    /**
     * Common
     */

    /**
     * @param SSODescriptorType[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstArtifactResolutionService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_ARTIFACT_RESOLUTION, $roleDescriptors, $binding);
    }

    /**
     * @param SSODescriptorType[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstSLOService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_SINGLE_LOGOUT, $roleDescriptors, $binding);
    }

    /**
     * @param SSODescriptorType[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstManageNameIDService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_MANAGE_NAME_ID, $roleDescriptors, $binding);
    }

    /**
     * Get First SP Services
     */

    /**
     * @param SPSSODescriptor[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstSpAssertionConsumerService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_ASSERTION_CONSUMER, $roleDescriptors, $binding);
    }

    /**
     * @param SPSSODescriptor[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstSpAttributeConsumingService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_ATTRIBUTE_CONSUMING, $roleDescriptors, $binding);
    }

    /**
     * Get First IDP Services
     */

    /**
     * @param IDPSSODescriptor[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstIdpSSOService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_SINGLE_SIGN_ON, $roleDescriptors, $binding);
    }

    /**
     * @param IDPSSODescriptor[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstIdpAssertionIdRequestService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_ASSERTION_ID_REQUEST, $roleDescriptors, $binding);
    }

    /**
     * @param IDPSSODescriptor[] $roleDescriptors
     * @param string $binding
     * @return EndpointType|null
     */
    public static function getFirstIdpNameIDMappingService(array $roleDescriptors, string $binding = null)
    {
        return static::getFirstService(self::ENDPOINT_SERVICE_NAME_ID_MAPPING, $roleDescriptors, $binding);
    }

    /**
     * @param SSODescriptorType[] $roleDescriptors
     * @param string $binding
     * @param string $service
     * @return EndpointType|null
     */
    protected static function getFirstService(string $service, array $roleDescriptors, string $binding = null)
    {

        if (! in_array($service, static::ENDPOINT_SERVICE_OPTIONS)) {
            throw new \InvalidArgumentException('Unknown service passed: ' . $service);
        }

        \Craft::info(
            sprintf(
                'Looping thru %s role descriptors',
                count($roleDescriptors)
            ),
            'saml-core'
        );

        $serviceMethod = 'get' . $service . 'Service';

        \Craft::info(
            'Using Service method: ' . $serviceMethod,
            'saml-core'
        );

        $return = null;
        foreach ($roleDescriptors as $descriptor) {
            if ($return = static::getFirstIndexedEndpointType(
                call_user_func([$descriptor, $serviceMethod]),
                $binding
            )
            ) {
                break;
            }
        }

        return $return;
    }

    /**
     * @param IndexedEndpointType[] $endpointTypes
     * @param $binding
     * @return EndpointType|null
     */
    protected static function getFirstIndexedEndpointType(array $endpointTypes, string $binding = null)
    {

        // Is there one?
        if (!isset($endpointTypes[0])) {
            return null;
        }

        // Default to the first one
        $return = $endpointTypes[0];
        if (is_null($binding)) {
            return $return;
        }

        // Reset the return
        $return = null;

        /** @var EndpointType $endpointType */
        foreach ($endpointTypes as $endpointType) {
            if (! $endpointType instanceof EndpointType) {
                throw new \InvalidArgumentException();
            }

            if ($endpointType->getBinding() === $binding) {
                $return = $endpointType;
                break;
            }
        }

        return $return;
    }
}