Kuleuven\AuthenticationBundle\Service\ShibbolethServiceProvider

Complexity

Total Complexity

43

Size/Duplication

Total Lines	421
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

27 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	30	1
A	isSecuredHandler()	0	4	1
A	getHandlerPath()	0	4	1
A	getSessionLoginPath()	0	4	1
A	getSessionLogoutPath()	0	4	1
A	getSessionOverviewPath()	0	4	1
A	getStatusPath()	0	4	1
A	getRequest()	0	8	2
A	getAttributes()	0	9	2
A	getAttribute()	0	5	1
A	hasAttribute()	0	5	1
B	hasAttributeValues()	0	23	5
A	isAuthenticated()	0	8	2
A	getUsername()	0	4	1
A	getAttributesByUsername()	0	8	2
A	getHandlerUrl()	0	5	2
A	getLoginUrl()	0	8	2
A	getLogoutUrl()	0	13	4
A	getOverviewUrl()	0	4	1
A	getStatusUrl()	0	4	1
A	getSessionInitiatorPath()	0	4	1
A	getUsernameAttribute()	0	4	1
A	getAuthenticatedAttribute()	0	4	1
A	getLogoutUrlAttribute()	0	4	1
A	getAuthenticationRequirements()	0	4	1
A	getDefaultCharset()	0	4	1
A	isReachable()	0	21	4

<?php

namespace Kuleuven\AuthenticationBundle\Service;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

class ShibbolethServiceProvider implements AttributesByUsernameProviderInterface
{
    /**
     * @var RequestStack
     */
    protected $requestStack;

    /**
     * @var AttributeDefinitionsProviderInterface
     */
    protected $attributeDefinitionsProvider;

    /**
     * @var bool
     */
    protected $securedHandler;

    /**
     * @var string
     */
    protected $handlerPath;

    /**
     * @var string
     */
    protected $statusPath;

    /**
     * @var string
     */
    protected $sessionLoginPath;

    /**
     * @var string
     */
    protected $sessionLogoutPath;

    /**
     * @var string
     */
    protected $sessionOverviewPath;

    /**
     * @var string
     */
    protected $usernameAttribute;

    /**
     * @var string
     */
    protected $authenticatedAttribute;

    /**
     * @var string
     */
    protected $logoutUrlAttribute;

    /**
     * @var array
     */
    protected $authenticationRequirements;

    /**
     * @var string
     */
    protected $defaultCharset;

    /**
     * @var Request
     */
    protected $request;

    /**
     * @var bool
     */
    protected $authenticated;

    /**
     * @param RequestStack                          $requestStack
     * @param AttributeDefinitionsProviderInterface $attributeDefinitionsProvider
     * @param bool                                  $securedHandler
     * @param string                                $handlerPath
     * @param string                                $statusPath
     * @param string                                $sessionLoginPath
     * @param string                                $sessionLogoutPath
     * @param string                                $sessionOverviewPath
     * @param string                                $usernameAttribute
     * @param string                                $authenticatedAttribute
     * @param string                                $logoutUrlAttribute
     * @param array                                 $authenticationRequirements
     * @param string                                $defaultCharset
     */
    public function __construct(
        RequestStack $requestStack,
        AttributeDefinitionsProviderInterface $attributeDefinitionsProvider,
        $securedHandler,
        $handlerPath,
        $statusPath,
        $sessionLoginPath,
        $sessionLogoutPath,
        $sessionOverviewPath,
        $usernameAttribute,
        $authenticatedAttribute,
        $logoutUrlAttribute,
        $authenticationRequirements,
        $defaultCharset
    )
    {
        $this->requestStack = $requestStack;
        $this->attributeDefinitionsProvider = $attributeDefinitionsProvider;
        $this->securedHandler = $securedHandler;
        $this->handlerPath = $handlerPath;
        $this->statusPath = $statusPath;
        $this->sessionLoginPath = $sessionLoginPath;
        $this->sessionLogoutPath = $sessionLogoutPath;
        $this->sessionOverviewPath = $sessionOverviewPath;
        $this->usernameAttribute = $usernameAttribute;
        $this->authenticatedAttribute = $authenticatedAttribute;
        $this->logoutUrlAttribute = $logoutUrlAttribute;
        $this->authenticationRequirements = $authenticationRequirements;
        $this->defaultCharset = $defaultCharset;
    }

    /**
     * @return bool
     */
    public function isSecuredHandler()
    {
        return $this->securedHandler;
    }

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

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

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

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

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

    /**
     * @return Request
     */
    protected function getRequest()
    {
        if (empty($this->request)) {
            $this->request = $this->requestStack->getCurrentRequest();
        }

        return $this->request;
    }

    /**
     * @param null $fallback
     * @return array
     */
    public function getAttributes($fallback = null)
    {
        $attributeDefinitions = $this->attributeDefinitionsProvider->getAttributeDefinitions();
        $attributes = [];
        foreach ($attributeDefinitions as $idOrAlias => $attributeDefinition) {
            $attributes[$idOrAlias] = $this->getAttribute($idOrAlias, $fallback);
        }
        return $attributes;
    }

    /**
     * @param string $name
     * @param null   $fallback
     * @return null|string
     */
    public function getAttribute($name, $fallback = null)
    {
        $request = $this->requestStack->getCurrentRequest();
        return $request->server->get($name, $fallback);
    }

    /**
     * @param string $name
     * @return bool
     */
    public function hasAttribute($name)
    {
        $empty = microtime(true);
        return $empty !== $this->getAttribute($name, $empty);
    }

    /**
     * @param array $keyValues
     * @return bool
     */
    public function hasAttributeValues(array $keyValues)
    {
        $result = true;
        $empty = microtime(true);
        set_error_handler(function ($errno, $errstr) {
            throw new \Exception($errstr, $errno);
        });
        foreach ($keyValues as $checkName => $checkValue) {
            $value = $this->getAttribute($checkName, $empty);
            if ($checkValue !== $value) {
                try {
                    $result = (1 === preg_match($checkValue, $value));
                } catch (\Exception $e) {
                    $result = false;
                }
            }
            if (!$result) {
                break;
            }
        }
        restore_error_handler();
        return $result;
    }

    /**
     * @return bool
     */
    public function isAuthenticated()
    {
        if (null === $this->authenticated) {
            $this->authenticated = $this->hasAttributeValues($this->getAuthenticationRequirements());
        }

        return $this->authenticated;
    }

    /**
     * @return string
     */
    public function getUsername()
    {
        return $this->getAttribute($this->usernameAttribute);
    }

    /**
     * @param $username
     * @return array
     */
    public function getAttributesByUsername($username)
    {
        if ($username !== $this->getUsername()) {
            return [];
        }

        return $this->getAttributes(null);
    }

    /**
     * Returns shibboleth session URL
     *
     * @return string
     */
    public function getHandlerUrl()
    {
        $request = $this->getRequest();
        return (($this->isSecuredHandler()) ? 'https://' : 'http://') . $request->getHost() . $this->getHandlerPath();
    }

    /**
     * Returns URL to initiate login session. After successful login, the user will be redirected
     * to the optional target page. The target can be an absolute or relative URL.
     *
     * @param string|null $target URL to redirect to after successful login. Defaults to the current request URL.
     * @return string The absolute URL to initiate a session
     */
    public function getLoginUrl($target = null)
    {
        $request = $this->getRequest();
        if (empty($target)) {
            $target = $request->getUri();
        }
        return $this->getHandlerUrl() . $this->getSessionLoginPath() . '?target=' . urlencode($target);
    }

    /**
     * Returns URL to invalidate the shibboleth session.
     *
     * @param null $target URL to redirect to after successful logout. Defaults to the current request URL.
     * @return string
     */
    public function getLogoutUrl($target = null)
    {
        $request = $this->getRequest();
        if (empty($target)) {
            $target = $request->getUri();
        }
        $logoutUrl = $this->getAttribute($this->logoutUrlAttribute);
        if (!empty($logoutUrl)) {
            return $this->getHandlerUrl() . $this->getSessionLogoutPath()
            . '?return=' . urlencode($logoutUrl . (empty($target) ? '' : '?return=' . $target));
        }
        return $this->getHandlerUrl() . $this->getSessionLogoutPath() . '?return=' . urlencode($target);
    }

    /**
     * Returns URL to show session.
     *
     * @return string The absolute URL to show a session
     */
    public function getOverviewUrl()
    {
        return $this->getHandlerUrl() . $this->getSessionOverviewPath();
    }

    /**
     * Returns URL to show status.
     *
     * @return string The absolute URL to show the status
     */
    public function getStatusUrl()
    {
        return $this->getHandlerUrl() . $this->getStatusPath();
    }

    /**
     * @deprecated
     * @return string
     */
    public function getSessionInitiatorPath()
    {
        return $this->sessionLoginPath;
    }

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

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

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

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

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

    /**
     * @param null|string $url
     * @return bool
     */
    public function isReachable($url = null)
    {
        if (null === $url) {
            $url = $this->getStatusUrl();
        }
        $handle = curl_init($url);
        if (false === $handle) {
            return false;
        }
        curl_setopt($handle, CURLOPT_FOLLOWLOCATION, true);
        curl_setopt($handle, CURLOPT_HEADER, false);
        curl_setopt($handle, CURLOPT_FAILONERROR, true);
        curl_setopt($handle, CURLOPT_NOBODY, true);
        curl_setopt($handle, CURLOPT_RETURNTRANSFER, false);
        $succeeded = curl_exec($handle);
        curl_close($handle);
        if (false === $succeeded) {
            return false;
        }
        return true;
    }
}