Property | Type | Description | |
---|---|---|---|
$config | SimpleSAML_Configuration | An instance of the configuration class. | |
$instance | string | The identifier of this discovery service. | |
$isPassive | boolean | HTTP parameter from the request, indicating whether the discovery service can interact with the user or not. | |
$metadata | SimpleSAML_Metadata_MetaDataStorageHandler | An instance of the metadata handler, which will allow us to fetch metadata about IdPs. | |
$metadataSets | array | The metadata sets we find allowed entities in, in prioritized order. | |
$returnIdParam | string | This option default to 'entityID' for Shibboleth compatibility. | |
$returnURL | string | The URL the user should be redirected to after choosing an IdP. | |
$scopedIDPList | array | The list of scoped idp's. The intersection between the metadata idpList and scopedIDPList (given as a $_GET IDPList[] parameter) is presented to the user. If the intersection is empty the metadata idpList is used. | |
$session | SimpleSAML_Session | The users session. | |
$setIdPentityID | string | null | .. | |
$spEntityId | string | The entity id of the SP which accesses this IdP discovery service. |
Method | Description | |
---|---|---|
__construct ( array $metadataSets, string $instance ) | Initializes this discovery service. | |
handleRequest ( ) | Handles a request to this discovery service. |
Method | Description | |
---|---|---|
filterList ( array $list ) : array | Filter the list of IdPs. | |
getCookie ( string $name ) : string | Retrieve cookie with the given name. | |
getFromCIDRhint ( ) : string | null | Retrieve a recommended IdP based on the IP address of the client. | |
getIdPList ( ) : array | Retrieve the list of IdPs which are stored in the metadata. | |
getPreviousIdP ( ) : string | Retrieve the previous IdP the user used. | |
getRecommendedIdP ( ) : string | Try to determine which IdP the user should most likely use. | |
getSavedIdP ( ) : string | Retrieve the users saved choice of IdP. | |
getScopedIDPList ( ) : array | Return the list of scoped idp | |
getSelectedIdP ( ) : string | Retrieve the users choice of IdP. | |
getTargetIdP ( ) : string | Determine which IdP the user should go to, if any. | |
log ( string $message ) | Log a message. | |
saveIdP ( ) : boolean | Determine whether the choice of IdP should be saved. | |
setCookie ( string $name, string $value ) | Save cookie with the given name and value. | |
setPreviousIdP ( string $idp ) | Save the current IdP choice to a cookie. | |
start ( ) : void | Check if an IdP is set or if the request is passive, and redirect accordingly. | |
validateIdP ( string | null $idp ) : string | null | Validates the given IdP entity id. |
public __construct ( array $metadataSets, string $instance ) | ||
$metadataSets | array | Array with metadata sets we find remote entities in. |
$instance | string | The name of this instance of the discovery service. |
protected filterList ( array $list ) : array | ||
$list | array | An associative array containing metadata for the IdPs to apply the filtering to. |
return | array | An associative array containing metadata for the IdPs that were not filtered out. |
protected getFromCIDRhint ( ) : string | null | ||
return | string | null | The entity ID of the IdP if one is found, or null if not. |
protected getIdPList ( ) : array | ||
return | array | An array with entityid => metadata mappings. |
protected getPreviousIdP ( ) : string | ||
return | string | The entity id of the previous IdP the user used, or null if this is the first time. |
protected getRecommendedIdP ( ) : string | ||
return | string | The entity id of the IdP the user should most likely use. |
protected getSavedIdP ( ) : string | ||
return | string | The entity id of the IdP the user has saved, or null if the user hasn't saved any choice. |
protected getScopedIDPList ( ) : array | ||
return | array | An array of IdP entities |
protected getSelectedIdP ( ) : string | ||
return | string | The entity id of the IdP the user has chosen, or null if the user has made no choice. |
protected getTargetIdP ( ) : string | ||
return | string | The entity id of the IdP the user should be sent to, or null if the user should choose. |
public handleRequest ( ) |
protected setPreviousIdP ( string $idp ) | ||
$idp | string | The entityID of the IdP. |
protected SimpleSAML_Configuration $config | ||
return | SimpleSAML_Configuration |
protected string $instance | ||
return | string |
protected bool $isPassive | ||
return | boolean |
protected SimpleSAML_Metadata_MetaDataStorageHandler $metadata | ||
return | SimpleSAML_Metadata_MetaDataStorageHandler |
protected array $metadataSets | ||
return | array |
protected string $returnIdParam | ||
return | string |
protected string $returnURL | ||
return | string |
protected array $scopedIDPList | ||
return | array |
protected SimpleSAML_Session $session | ||
return | SimpleSAML_Session |
protected string $spEntityId | ||
return | string |