Inheritance diagram for sspmod_discopower_PowerIdPDisco:

Collaboration diagram for sspmod_discopower_PowerIdPDisco:

Public Member Functions
	__construct (array $metadataSets, $instance)
	Initializes this discovery service. More...

	handleRequest ()
	Handles a request to this discovery service. More...

Public Member Functions inherited from SimpleSAML_XHTML_IdPDisco
	__construct (array $metadataSets, $instance)
	Initializes this discovery service. More...

	handleRequest ()
	Handles a request to this discovery service. More...

Static Public Member Functions
static	mcmp (array $a, array $b)
	Compare two entities. More...

Protected Member Functions
	log ($message)
	Log a message. More...

	idplistStructured ($list)
	Structure the list of IdPs in a hierarchy based upon the tags. More...

	filterList ($list)
	Filter a list of entities according to any filters defined in the parent class, plus discopower configuration options regarding filtering. More...

	setPreviousIdP ($idp)
	Save the current IdP choice to a cookie. More...

	getPreviousIdP ()
	Retrieve the previous IdP the user used. More...

Protected Member Functions inherited from SimpleSAML_XHTML_IdPDisco
	log ($message)
	Log a message. More...

	getCookie ($name)
	Retrieve cookie with the given name. More...

	setCookie ($name, $value)
	Save cookie with the given name and value. More...

	validateIdP ($idp)
	Validates the given IdP entity id. More...

	getSelectedIdP ()
	Retrieve the users choice of IdP. More...

	getSavedIdP ()
	Retrieve the users saved choice of IdP. More...

	getPreviousIdP ()
	Retrieve the previous IdP the user used. More...

	getFromCIDRhint ()
	Retrieve a recommended IdP based on the IP address of the client. More...

	getRecommendedIdP ()
	Try to determine which IdP the user should most likely use. More...

	setPreviousIdP ($idp)
	Save the current IdP choice to a cookie. More...

	saveIdP ()
	Determine whether the choice of IdP should be saved. More...

	getTargetIdP ()
	Determine which IdP the user should go to, if any. More...

	getIdPList ()
	Retrieve the list of IdPs which are stored in the metadata. More...

	getScopedIDPList ()
	Return the list of scoped idp. More...

	filterList ($list)
	Filter the list of IdPs. More...

	start ()
	Check if an IdP is set or if the request is passive, and redirect accordingly. More...

Private Member Functions
	processFilter ($filter, $entry, $default=true)
	Do the actual filtering according the rules defined. More...

	getCDC ()
	Get the IdP entities saved in the common domain cookie. More...

Private Attributes
	$discoconfig

	$cdcDomain

	$cdcLifetime

Additional Inherited Members
Protected Attributes inherited from SimpleSAML_XHTML_IdPDisco
	$config

	$instance

	$metadata

	$session

	$metadataSets

	$spEntityId

	$isPassive

	$setIdPentityID = null

	$returnIdParam

	$scopedIDPList = array()

	$returnURL

Detailed Description

Definition at line 13 of file PowerIdPDisco.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_discopower_PowerIdPDisco::__construct	(	array	$metadataSets,
			$instance
	)

Initializes this discovery service.

The constructor does the parsing of the request. If this is an invalid request, it will throw an exception.

Parameters

array	$metadataSets	Array with metadata sets we find remote entities in.
string	$instance	The name of this instance of the discovery service.

Definition at line 50 of file PowerIdPDisco.php.

References SimpleSAML_XHTML_IdPDisco\$instance, and SimpleSAML_Configuration\getConfig().

     {
         parent::__construct($metadataSets, $instance);
 
         $this->discoconfig = SimpleSAML_Configuration::getConfig('module_discopower.php');
 
         $this->cdcDomain = $this->discoconfig->getString('cdc.domain', null);
         if ($this->cdcDomain !== null && $this->cdcDomain[0] !== '.') {
             // ensure that the CDC domain starts with a dot ('.') as required by the spec
             $this->cdcDomain = '.'.$this->cdcDomain;
         }
 
         $this->cdcLifetime = $this->discoconfig->getInteger('cdc.lifetime', null);
     }

Here is the call graph for this function:

Member Function Documentation

◆ filterList()

sspmod_discopower_PowerIdPDisco::filterList ( $list )

protected

Filter a list of entities according to any filters defined in the parent class, plus discopower configuration options regarding filtering.

Parameters

array $list A list of entities to filter.

Returns: array The list in $list after filtering entities.

Definition at line 187 of file PowerIdPDisco.php.

References $key, $list, $spmd, array, and processFilter().

Referenced by handleRequest().

     {
         $list = parent::filterList($list);
 
         try {
             $spmd = $this->metadata->getMetaData($this->spEntityId, 'saml20-sp-remote');
         } catch (Exception $e) {
             return $list;
         }
 
         if (!isset($spmd)) {
             return $list;
         }
         if (!array_key_exists('discopower.filter', $spmd)) {
             return $list;
         }
         $filter = $spmd['discopower.filter'];
 
         if (!array_key_exists('entities.include', $filter)) {
             $filter['entities.include'] = array();
         }
         if (!array_key_exists('entities.exclude', $filter)) {
             $filter['entities.exclude'] = array();
         }
         if (!array_key_exists('tags.include', $filter)) {
             $filter['tags.include'] = array();
         }
         if (!array_key_exists('tags.exclude', $filter)) {
             $filter['tags.exclude'] = array();
         }
 
         $defaultrule = true;
         if (array_key_exists('entities.include', $spmd['discopower.filter']) ||
             array_key_exists('tags.include', $spmd['discopower.filter'])
         ) {
 
             $defaultrule = false;
         }
 
         $returnlist = array();
         foreach ($list as $key => $entry) {
             if ($this->processFilter($filter, $entry, $defaultrule)) {
                 $returnlist[$key] = $entry;
             }
         }
         return $returnlist;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCDC()

sspmod_discopower_PowerIdPDisco::getCDC ( )

private

Get the IdP entities saved in the common domain cookie.

Returns: array List of IdP entities.

Definition at line 293 of file PowerIdPDisco.php.

References $_COOKIE, $idp, $ret, array, and string.

Referenced by getPreviousIdP(), and setPreviousIdP().

     {
         if (!isset($_COOKIE['_saml_idp'])) {
             return array();
         }
 
         $ret = (string) $_COOKIE['_saml_idp'];
         $ret = explode(' ', $ret);
         foreach ($ret as &$idp) {
             $idp = base64_decode($idp);
             if ($idp === false) {
                 // not properly base64 encoded
                 return array();
             }
         }
 
         return $ret;
     }

Here is the caller graph for this function:

◆ getPreviousIdP()

sspmod_discopower_PowerIdPDisco::getPreviousIdP ( )

protected

Retrieve the previous IdP the user used.

This function overrides the corresponding function in the parent class, to add support for common domain cookie.

Returns: string|null The entity id of the previous IdP the user used, or null if this is the first time.

Definition at line 369 of file PowerIdPDisco.php.

References $idp, getCDC(), and SimpleSAML_XHTML_IdPDisco\validateIdP().

     {
         if ($this->cdcDomain === null) {
             return parent::getPreviousIdP();
         }
 
         $prevIdPs = $this->getCDC();
         while (count($prevIdPs) > 0) {
             $idp = array_pop($prevIdPs);
             $idp = $this->validateIdP($idp);
             if ($idp !== null) {
                 return $idp;
             }
         }
 
         return null;
     }

Here is the call graph for this function:

◆ handleRequest()

sspmod_discopower_PowerIdPDisco::handleRequest ( )

Handles a request to this discovery service.

The IdP disco parameters should be set before calling this function.

Definition at line 241 of file PowerIdPDisco.php.

References SimpleSAML_XHTML_IdPDisco\$returnIdParam, SimpleSAML_XHTML_IdPDisco\$returnURL, $slist, SimpleSAML_XHTML_IdPDisco\$spEntityId, $t, $tab, array, filterList(), SimpleSAML_XHTML_IdPDisco\getIdPList(), SimpleSAML_XHTML_IdPDisco\getRecommendedIdP(), idplistStructured(), and SimpleSAML_XHTML_IdPDisco\start().

     {
         $this->start();
 
         // no choice made. Show discovery service page
         $idpList = $this->getIdPList();
         $idpList = $this->idplistStructured($this->filterList($idpList));
         $preferredIdP = $this->getRecommendedIdP();
         $faventry = NULL;
         foreach ($idpList AS $tab => $slist) {
             if (!empty($preferredIdP) && array_key_exists($preferredIdP, $slist)) {
                 $faventry = $slist[$preferredIdP];
             }
         }
 
         $t = new SimpleSAML_XHTML_Template($this->config, 'discopower:disco.tpl.php', 'disco');
         $discoPowerTabs = array(
             'denmark' => $t->noop('{discopower:tabs:denmark}'),
             'edugain' => $t->noop('{discopower:tabs:edugain}'),
             'finland' => $t->noop('{discopower:tabs:finland}'),
             'greece' => $t->noop('{discopower:tabs:greece}'),
             'southafrica' => $t->noop('{discopower:tabs:southafrica}'),
             'iceland' => $t->noop('{discopower:tabs:iceland}'),
             'incommon' => $t->noop('{discopower:tabs:incommon}'),
             'kalmar' => $t->noop('{discopower:tabs:kalmar}'),
             'misc' => $t->noop('{discopower:tabs:misc}'),
             'norway' => $t->noop('{discopower:tabs:norway}'),
             'sweden' => $t->noop('{discopower:tabs:sweden}'),
             'switzerland' => $t->noop('{discopower:tabs:switzerland}'),
             'ukacessfederation' => $t->noop('{discopower:tabs:ukacessfederation}'),
         );
         $t->data['faventry'] = $faventry;
         $t->data['tabNames'] = $discoPowerTabs;
         $t->data['idplist'] = $idpList;
         $t->data['preferredidp'] = $preferredIdP;
         $t->data['return'] = $this->returnURL;
         $t->data['returnIDParam'] = $this->returnIdParam;
         $t->data['entityID'] = $this->spEntityId;
         $t->data['urlpattern'] = htmlspecialchars(\SimpleSAML\Utils\HTTP::getSelfURLNoQuery());
         $t->data['rememberenabled'] = $this->config->getBoolean('idpdisco.enableremember', false);
         $t->data['rememberchecked'] = $this->config->getBoolean('idpdisco.rememberchecked', false);
         $t->data['defaulttab'] = $this->discoconfig->getValue('defaulttab', 0);
         $t->data['score'] = $this->discoconfig->getValue('score', 'quicksilver');
         $t->show();
     }

Here is the call graph for this function:

◆ idplistStructured()

sspmod_discopower_PowerIdPDisco::idplistStructured ( $list )

protected

Structure the list of IdPs in a hierarchy based upon the tags.

Parameters

array $list A list of IdPs.

Returns: array The list of IdPs structured accordingly.

Definition at line 111 of file PowerIdPDisco.php.

References $key, $list, $slist, $tab, $tag, $tags, and array.

Referenced by handleRequest().

     {
         $slist = array();
 
         $order = $this->discoconfig->getValue('taborder');
         if (is_array($order)) {
             foreach ($order as $oe) {
                 $slist[$oe] = array();
             }
         }
 
         $enableTabs = $this->discoconfig->getValue('tabs', null);
 
         foreach ($list as $key => $val) {
             $tags = array('misc');
             if (array_key_exists('tags', $val)) {
                 $tags = $val['tags'];
             }
             foreach ($tags as $tag) {
                 if (!empty($enableTabs) && !in_array($tag, $enableTabs, true)) {
                     continue;
                 }
                 $slist[$tag][$key] = $val;
             }
         }
 
         foreach ($slist as $tab => $tbslist) {
             uasort($slist[$tab], array('sspmod_discopower_PowerIdPDisco', 'mcmp'));
         }
 
         return $slist;
     }

Here is the caller graph for this function:

◆ log()

sspmod_discopower_PowerIdPDisco::log ( $message )

protected

Log a message.

This is an helper function for logging messages. It will prefix the messages with our discovery service type.

Parameters

string $message The message which should be logged.

Definition at line 73 of file PowerIdPDisco.php.

References $message, and SimpleSAML\Logger\info().

     {
         SimpleSAML\Logger::info('PowerIdPDisco.'.$this->instance.': '.$message);
     }

Here is the call graph for this function:

◆ mcmp()

static sspmod_discopower_PowerIdPDisco::mcmp	(	array	$a,
		array	$b
	)

static

Compare two entities.

This function is used to sort the entity list. It sorts based on english name, and will always put IdP's with names configured before those with only an entityID.

Parameters

array	$a	The metadata of the first entity.
array	$b	The metadata of the second entity.

Returns: int How $a compares to $b.

Definition at line 90 of file PowerIdPDisco.php.

     {
         if (isset($a['name']['en']) && isset($b['name']['en'])) {
             return strcasecmp($a['name']['en'], $b['name']['en']);
         } elseif (isset($a['name']['en'])) {
             return -1; // place name before entity ID
         } elseif (isset($b['name']['en'])) {
             return 1; // Place entity ID after name
         } else {
             return strcasecmp($a['entityid'], $b['entityid']);
         }
     }

◆ processFilter()

sspmod_discopower_PowerIdPDisco::processFilter	(	$filter,
		$entry,
		$default = `true`
	)

private

Do the actual filtering according the rules defined.

Parameters

array	$filter	A set of rules regarding filtering.
array	$entry	An entry to be evaluated by the filters.
boolean	$default	What to do in case the entity does not match any rules. Defaults to true.

Returns: boolean True if the entity should be kept, false if it should be discarded according to the filters.

Definition at line 154 of file PowerIdPDisco.php.

Referenced by filterList().

     {
         if (in_array($entry['entityid'], $filter['entities.include'], true)) {
             return true;
         }
         if (in_array($entry['entityid'], $filter['entities.exclude'], true)) {
             return false;
         }
 
         if (array_key_exists('tags', $entry)) {
             foreach ($filter['tags.include'] as $fe) {
                 if (in_array($fe, $entry['tags'], true)) {
                     return true;
                 }
             }
             foreach ($filter['tags.exclude'] as $fe) {
                 if (in_array($fe, $entry['tags'], true)) {
                     return false;
                 }
             }
         }
         return $default;
     }

Here is the caller graph for this function:

◆ setPreviousIdP()

sspmod_discopower_PowerIdPDisco::setPreviousIdP ( $idp )

protected

Save the current IdP choice to a cookie.

This function overrides the corresponding function in the parent class, to add support for common domain cookie.

Parameters

string $idp The entityID of the IdP.

Definition at line 320 of file PowerIdPDisco.php.

References $idp, $list, $params, array, getCDC(), and SimpleSAML\Utils\HTTP\setCookie().

     {
         assert('is_string($idp)');
 
         if ($this->cdcDomain === null) {
             parent::setPreviousIdP($idp);
             return;
         }
 
         $list = $this->getCDC();
 
         $prevIndex = array_search($idp, $list, true);
         if ($prevIndex !== false) {
             unset($list[$prevIndex]);
         }
         $list[] = $idp;
 
         foreach ($list as &$value) {
             $value = base64_encode($value);
         }
         $newCookie = implode(' ', $list);
 
         while (strlen($newCookie) > 4000) {
             // the cookie is too long. Remove the oldest elements until it is short enough
             $tmp = explode(' ', $newCookie, 2);
             if (count($tmp) === 1) {
                 // we are left with a single entityID whose base64 representation is too long to fit in a cookie
                 break;
             }
             $newCookie = $tmp[1];
         }
 
         $params = array(
             'lifetime' => $this->cdcLifetime,
             'domain'   => $this->cdcDomain,
             'secure'   => true,
             'httponly' => false,
         );
         \SimpleSAML\Utils\HTTP::setCookie('_saml_idp', $newCookie, $params, false);
     }

Here is the call graph for this function:

Field Documentation

◆ $cdcDomain

sspmod_discopower_PowerIdPDisco::$cdcDomain

private

Definition at line 31 of file PowerIdPDisco.php.

◆ $cdcLifetime

sspmod_discopower_PowerIdPDisco::$cdcLifetime

private

Definition at line 39 of file PowerIdPDisco.php.

◆ $discoconfig

sspmod_discopower_PowerIdPDisco::$discoconfig

private

Definition at line 22 of file PowerIdPDisco.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/discopower/lib/PowerIdPDisco.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ filterList()

◆ getCDC()

◆ getPreviousIdP()

◆ handleRequest()

◆ idplistStructured()

◆ log()

◆ mcmp()

◆ processFilter()

◆ setPreviousIdP()

Field Documentation

◆ $cdcDomain

◆ $cdcLifetime

◆ $discoconfig