ilSimpleSAMLphplIdpDiscovery Class Reference

Class ilSimpleSAMLphplIdpDiscovery. More...

Inheritance diagram for ilSimpleSAMLphplIdpDiscovery:

Collaboration diagram for ilSimpleSAMLphplIdpDiscovery:

Public Member Functions
	__construct ()
	ilSimpleSAMLphplIdpDiscovery constructor. More...
	getMetadataDirectory ()
	getList ()
	This method should return an array of IDPs.Each element should be an array as well, providing at least a value for key 'entityid'. Returns array More...
	storeIdpMetadata ($idpId, $metadata)
	Parameters int $idpId string $metadata More...
	fetchIdpMetadata ($idpId)
	Parameters int $idpId More...
	deleteIdpMetadata ($idpId)
	Parameters int $idpId 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...
	getList ()
	This method should return an array of IDPs. More...
	storeIdpMetadata ($idpId, $metadata)
	fetchIdpMetadata ($idpId)
	deleteIdpMetadata ($idpId)

Data Fields
const	METADATA_DIRECTORY = 'auth/saml/metadata'

Protected Member Functions
	getMetadataPath ($idpId)
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...

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

Class ilSimpleSAMLphplIdpDiscovery.

Definition at line 9 of file class.ilSimpleSAMLphplIdpDiscovery.php.

Constructor & Destructor Documentation

__construct()

ilSimpleSAMLphplIdpDiscovery::__construct

(

)

ilSimpleSAMLphplIdpDiscovery constructor.

Definition at line 16 of file class.ilSimpleSAMLphplIdpDiscovery.php.

    {
        $this->config       = SimpleSAML_Configuration::getInstance();
        $this->metadata     = SimpleSAML_Metadata_MetaDataStorageHandler::getMetadataHandler();
        $this->instance     = 'saml';
        $this->metadataSets = array('saml20-idp-remote');
        $this->isPassive    = false;
    }

References SimpleSAML_Configuration\getInstance(), and SimpleSAML_Metadata_MetaDataStorageHandler\getMetadataHandler().

Here is the call graph for this function:

Member Function Documentation

deleteIdpMetadata()

ilSimpleSAMLphplIdpDiscovery::deleteIdpMetadata

(

$idpId

)

Parameters

int

$idpId

Implements ilSamlIdpDiscovery.

Definition at line 81 of file class.ilSimpleSAMLphplIdpDiscovery.php.

    {
        global $DIC;
 
        $fs = $DIC->filesystem()->storage();
 
        if ($fs->has($this->getMetadataPath($idpId))) {
            $fs->delete($this->getMetadataPath($idpId));
        }
    }

References $DIC, and getMetadataPath().

Here is the call graph for this function:

fetchIdpMetadata()

ilSimpleSAMLphplIdpDiscovery::fetchIdpMetadata

(

$idpId

)

Parameters

int

$idpId

Implements ilSamlIdpDiscovery.

Definition at line 65 of file class.ilSimpleSAMLphplIdpDiscovery.php.

    {
        global $DIC;
 
        $fs = $DIC->filesystem()->storage();
 
        if (!$fs->has($this->getMetadataPath($idpId))) {
            return '';
        }
 
        return $fs->read($this->getMetadataPath($idpId));
    }

References $DIC, and getMetadataPath().

Here is the call graph for this function:

getList()

ilSimpleSAMLphplIdpDiscovery::getList

(

)

This method should return an array of IDPs.Each element should be an array as well, providing at least a value for key 'entityid'.

Returns

array

Implements ilSamlIdpDiscovery.

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

    {
        return $this->getIdPList();
    }

References SimpleSAML_XHTML_IdPDisco\getIdPList().

Here is the call graph for this function:

getMetadataDirectory()

ilSimpleSAMLphplIdpDiscovery::getMetadataDirectory

(

)

Returns

string

Definition at line 28 of file class.ilSimpleSAMLphplIdpDiscovery.php.

    {
        return self::METADATA_DIRECTORY;
    }

References METADATA_DIRECTORY.

Referenced by getMetadataPath().

Here is the caller graph for this function:

getMetadataPath()

ilSimpleSAMLphplIdpDiscovery::getMetadataPath (   $idpId )

protected

Parameters

int

$idpId

Returns

string

Definition at line 45 of file class.ilSimpleSAMLphplIdpDiscovery.php.

    {
        return $this->getMetadataDirectory() . '/' . $idpId . '.xml';
    }

References getMetadataDirectory().

Referenced by deleteIdpMetadata(), fetchIdpMetadata(), and storeIdpMetadata().

Here is the call graph for this function:

Here is the caller graph for this function:

storeIdpMetadata()

ilSimpleSAMLphplIdpDiscovery::storeIdpMetadata	(		$idpId,
			$metadata
	)

Parameters

int	$idpId
string	$metadata

Implements ilSamlIdpDiscovery.

Definition at line 53 of file class.ilSimpleSAMLphplIdpDiscovery.php.

    {
        global $DIC;
 
        $fs = $DIC->filesystem()->storage();
 
        $fs->put($this->getMetadataPath($idpId), $metadata);
    }

References $DIC, SimpleSAML_XHTML_IdPDisco\$metadata, and getMetadataPath().

Here is the call graph for this function:

Field Documentation

METADATA_DIRECTORY

const ilSimpleSAMLphplIdpDiscovery::METADATA_DIRECTORY = 'auth/saml/metadata'

Definition at line 11 of file class.ilSimpleSAMLphplIdpDiscovery.php.

Referenced by getMetadataDirectory().

---

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

• Services/Saml/classes/class.ilSimpleSAMLphplIdpDiscovery.php