class.ilShibbolethWAYF.php

Go to the documentation of this file.

<?php

use ILIAS\HTTP\Wrapper\WrapperFactory;
use ILIAS\Refinery\Factory as Refinery;

class ilShibbolethWAYF
{
    public const COOKIE_NAME_SAML_IDP = '_saml_idp';
    public bool $is_selection = false;
    public bool $is_valid_selection = false;
    public string $selected_idp = '-';
    public array $idp_list = [];
    protected WrapperFactory $wrapper;
    protected ilLanguage $lng;
    protected ilSetting $settings;
    protected Refinery $refinery;

    public function __construct()
    {
        global $DIC;

        // Was the WAYF form submitted?
        $this->wrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
        $this->settings = $DIC->settings();
        $this->is_selection = $this->wrapper->post()->has('home_organization_selection');
        $this->lng = $DIC->isDependencyAvailable('language')
            ? $DIC->language()
            : new ilLanguage(
                $this->wrapper->query()->has('lang')
                ? $this->wrapper->query()->retrieve('lang', $DIC->refinery()->to()->string())
                : null
            );

        // Was selected IdP a valid
        $this->idp_list = $this->getIdplist();
        $idp_selection = $this->wrapper->post()->has('idp_selection')
            ? $this->wrapper->post()->retrieve('idp_selection', $DIC->refinery()->to()->string())
            : null;
        if ($idp_selection !== null
            && $idp_selection !== '-'
            && isset($this->idp_list[$idp_selection])
        ) {
            $this->is_valid_selection = true;
            $this->selected_idp = $idp_selection;
        } else {
            $this->is_valid_selection = false;
        }
    }

    public function isSelection(): bool
    {
        return $this->is_selection;
    }

    public function isValidSelection(): bool
    {
        return $this->is_valid_selection;
    }

    public function generateSelection(): string
    {
        $saml_idp = $this->wrapper->cookie()->has(self::COOKIE_NAME_SAML_IDP)
            ? $this->wrapper->cookie()->retrieve(
                self::COOKIE_NAME_SAML_IDP,
                $this->refinery->kindlyTo()->string()
            )
            : null;
        $idp_cookie = $this->generateCookieArray($saml_idp);

        $selected_idp = null;
        if ($idp_cookie !== [] && isset($this->idp_list[end($idp_cookie)])) {
            $selected_idp = end($idp_cookie);
            $select_element = '
                <select name="idp_selection">
                        <option value="-">' . $this->lng->txt("shib_member_of") . '</option>';
        } else {
            $select_element = '
                <select name="idp_selection">
                        <option value="-" selected="selected">' . $this->lng->txt("shib_member_of") . '</option>';
        }

        foreach ($this->idp_list as $idp_id => $idp_data) {
            if ($idp_id === $selected_idp) {
                $select_element .= '<option value="' . $idp_id . '" selected="selected">' . $idp_data[0] . '</option>';
            } else {
                $select_element .= '<option value="' . $idp_id . '">' . $idp_data[0] . '</option>';
            }
        }

        return $select_element . '
                </select>';
    }

    public function redirect(): void
    {
        // Where to return after the authentication process
        $target = $this->wrapper->post()->has('il_target')
            ? $this->wrapper->post()->retrieve('il_target', $this->refinery->kindlyTo()->string())
            : '';
        $target = trim(ILIAS_HTTP_PATH, '/') . '/shib_login.php?target=' . $target;
        $idp_data = $this->idp_list[$this->selected_idp];
        if (isset($idp_data[1])) {
            ilUtil::redirect($idp_data[1] . '?providerId=' . urlencode($this->selected_idp) . '&target='
                . urlencode($target));
        } else {
            // TODO: This has to be changed to /Shibboleth.sso/DS?entityId= for
            // Shibboleth 2.x sometime...
            ilUtil::redirect('/Shibboleth.sso?providerId=' . urlencode($this->selected_idp) . '&target='
                . urlencode($target));
        }
    }

    public function setSAMLCookie(): void
    {
        $_saml_idp = $this->wrapper->cookie()->retrieve(self::COOKIE_NAME_SAML_IDP, $this->refinery->kindlyTo()->string());
        $arr_idps = $_saml_idp ? $this->generateCookieArray($_saml_idp) : [];
        $arr_idps = $this->appendCookieValue($this->selected_idp, $arr_idps);
        setcookie(self::COOKIE_NAME_SAML_IDP, $this->generateCookieValue($arr_idps), ['expires' => time() + (100 * 24 * 3600), 'path' => '/']);
    }

    public function showNotice(): string
    {
        if (!$this->isSelection() || $this->isValidSelection()) {
            return '';
        }

        return $this->lng->txt("shib_invalid_home_organization");
    }

    public function getIdplist(): array
    {
        $idp_list = [];
        $idp_raw_list = explode("\n", (string) $this->settings->get("shib_idp_list"));
        foreach ($idp_raw_list as $idp_line) {
            $idp_data = explode(',', $idp_line);
            if (isset($idp_data[2])) {
                $idp_list[trim($idp_data[0])] = [trim($idp_data[1]), trim($idp_data[2])];
            } elseif (isset($idp_data[1])) {
                $idp_list[trim($idp_data[0])] = [trim($idp_data[1])];
            }
        }

        return $idp_list;
    }

    public function generateCookieArray(?string $value): array
    {
        if (null === $value) {
            return [];
        }
        $arr_cookie = explode(' ', $value);
        return array_map('base64_decode', $arr_cookie);
    }

    public function generateCookieValue(array $arr_cookie): string
    {
        $arr_cookie = array_map('base64_encode', $arr_cookie);
        return implode(' ', $arr_cookie);
    }

    public function appendCookieValue(string $value, array $arr_cookie): array
    {
        $arr_cookie[] = $value;
        $arr_cookie = array_reverse($arr_cookie);
        $arr_cookie = array_unique($arr_cookie);
        return array_reverse($arr_cookie);
    }
}