Class ShibbolethWAYF. More...

Collaboration diagram for ilShibbolethWAYF:

Public Member Functions
	__construct ()

	isSelection ()

	isValidSelection ()

	generateSelection ()

	redirect ()
	@description Redirects user to the local Shibboleth session initatiotor with already set GET arguments for the right IdP and return location. More...

	setSAMLCookie ()
	@description Sets the standard SAML domain cookie that is also used to preselect the right entry on the local wayf More...

	showNotice ()
	@description Show notice in case no IdP was selected More...

	getIdplist ()
	@description Generate array of IdPs from ILIAS Shibboleth settings More...

	generateCookieArray (?string $value)
	@description Generates an array of IDPs using the cookie value More...

	generateCookieValue (array $arr_cookie)
	@description Generate the value that is stored in the cookie using the list of IDPs More...

	appendCookieValue (string $value, array $arr_cookie)
	@description Append a value to the array of IDPs More...

Data Fields
const	COOKIE_NAME_SAML_IDP = '_saml_idp'

bool	$is_selection = false

bool	$is_valid_selection = false

string	$selected_idp = '-'

array	$idp_list = []

Protected Attributes
WrapperFactory	$wrapper

ilLanguage	$lng

ilSetting	$settings

Refinery	$refinery

Detailed Description

Class ShibbolethWAYF.

This class handles the Home Organization selection (also called Where Are You From service) process for Shibboleth users.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 32 of file class.ilShibbolethWAYF.php.

Constructor & Destructor Documentation

◆ __construct()

ilShibbolethWAYF::__construct ( )

Definition at line 44 of file class.ilShibbolethWAYF.php.

    {
        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;
        }
    }

References $DIC, getIdplist(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ appendCookieValue()

ilShibbolethWAYF::appendCookieValue	(	string	$value,
		array	$arr_cookie
	)

@description Append a value to the array of IDPs

Definition at line 211 of file class.ilShibbolethWAYF.php.

                                                                       : array
    {
        $arr_cookie[] = $value;
        $arr_cookie = array_reverse($arr_cookie);
        $arr_cookie = array_unique($arr_cookie);
        return array_reverse($arr_cookie);
    }

Referenced by setSAMLCookie().

Here is the caller graph for this function:

◆ generateCookieArray()

ilShibbolethWAYF::generateCookieArray ( ?string $value )

@description Generates an array of IDPs using the cookie value

Returns: bool[]|string[]

Definition at line 190 of file class.ilShibbolethWAYF.php.

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

Referenced by generateSelection(), and setSAMLCookie().

Here is the caller graph for this function:

◆ generateCookieValue()

ilShibbolethWAYF::generateCookieValue ( array $arr_cookie )

@description Generate the value that is stored in the cookie using the list of IDPs

Definition at line 202 of file class.ilShibbolethWAYF.php.

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

Referenced by setSAMLCookie().

Here is the caller graph for this function:

◆ generateSelection()

ilShibbolethWAYF::generateSelection ( )

Definition at line 87 of file class.ilShibbolethWAYF.php.

                                       : 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>';
    }

References $selected_idp, generateCookieArray(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ getIdplist()

ilShibbolethWAYF::getIdplist ( )

@description Generate array of IdPs from ILIAS Shibboleth settings

Returns: array<string, string[]>

Definition at line 170 of file class.ilShibbolethWAYF.php.

                                : 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;
    }

References $idp_list, and ILIAS\Repository\settings().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSelection()

ilShibbolethWAYF::isSelection ( )

Definition at line 77 of file class.ilShibbolethWAYF.php.

                                 : bool
    {
        return $this->is_selection;
    }

References $is_selection.

Referenced by showNotice().

Here is the caller graph for this function:

◆ isValidSelection()

ilShibbolethWAYF::isValidSelection ( )

Definition at line 82 of file class.ilShibbolethWAYF.php.

                                      : bool
    {
        return $this->is_valid_selection;
    }

References $is_valid_selection.

Referenced by showNotice().

Here is the caller graph for this function:

◆ redirect()

ilShibbolethWAYF::redirect ( )

@description Redirects user to the local Shibboleth session initatiotor with already set GET arguments for the right IdP and return location.

Definition at line 124 of file class.ilShibbolethWAYF.php.

                              : 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));
        }
    }

References $selected_idp, ilUtil\redirect(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ setSAMLCookie()

ilShibbolethWAYF::setSAMLCookie ( )

@description Sets the standard SAML domain cookie that is also used to preselect the right entry on the local wayf

Definition at line 146 of file class.ilShibbolethWAYF.php.

                                   : 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' => '/']);
    }

References appendCookieValue(), generateCookieArray(), generateCookieValue(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ showNotice()

ilShibbolethWAYF::showNotice ( )

@description Show notice in case no IdP was selected

Definition at line 157 of file class.ilShibbolethWAYF.php.

                                : string
    {
        if (!$this->isSelection() || $this->isValidSelection()) {
            return '';
        }
 
        return $this->lng->txt("shib_invalid_home_organization");
    }

References isSelection(), isValidSelection(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

◆ $idp_list

array ilShibbolethWAYF::$idp_list = []

Definition at line 38 of file class.ilShibbolethWAYF.php.

Referenced by getIdplist().

◆ $is_selection

bool ilShibbolethWAYF::$is_selection = false

Definition at line 35 of file class.ilShibbolethWAYF.php.

Referenced by isSelection().

◆ $is_valid_selection

bool ilShibbolethWAYF::$is_valid_selection = false

Definition at line 36 of file class.ilShibbolethWAYF.php.

Referenced by isValidSelection().

◆ $lng

ilLanguage ilShibbolethWAYF::$lng

protected

Definition at line 40 of file class.ilShibbolethWAYF.php.

◆ $refinery

Refinery ilShibbolethWAYF::$refinery

protected

Definition at line 42 of file class.ilShibbolethWAYF.php.

◆ $selected_idp

string ilShibbolethWAYF::$selected_idp = '-'

Definition at line 37 of file class.ilShibbolethWAYF.php.

Referenced by generateSelection(), and redirect().

◆ $settings

ilSetting ilShibbolethWAYF::$settings

protected

Definition at line 41 of file class.ilShibbolethWAYF.php.

◆ $wrapper

WrapperFactory ilShibbolethWAYF::$wrapper

protected

Definition at line 39 of file class.ilShibbolethWAYF.php.

◆ COOKIE_NAME_SAML_IDP

const ilShibbolethWAYF::COOKIE_NAME_SAML_IDP = '_saml_idp'

Definition at line 34 of file class.ilShibbolethWAYF.php.

The documentation for this class was generated from the following file:

components/ILIAS/AuthShibboleth/classes/class.ilShibbolethWAYF.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendCookieValue()

◆ generateCookieArray()

◆ generateCookieValue()

◆ generateSelection()

◆ getIdplist()

◆ isSelection()

◆ isValidSelection()

◆ redirect()

◆ setSAMLCookie()

◆ showNotice()

Field Documentation

◆ $idp_list

◆ $is_selection

◆ $is_valid_selection

◆ $lng

◆ $refinery

◆ $selected_idp

◆ $settings

◆ $wrapper

◆ COOKIE_NAME_SAML_IDP