auth_shibboleth

Files
file	admin_setting_special_idp_configtextarea.php
	Special setting for auth_shibboleth WAYF.
file	admin_setting_special_wayf_select.php
	Special settings for auth_shibboleth WAYF.
file	auth.php
	Authentication Plugin: Shibboleth Authentication Authentication using Shibboleth.
file	helper.php
	Contains a helper class for the Shibboleth authentication plugin.
file	lib.php
	This file contains the hooks for the Shibboleth authentication module.
file	provider.php
	Privacy Subsystem implementation for auth_shibboleth.
file	settings.php
	Admin settings and defaults.
file	upgrade.php
	Shibboleth authentication plugin upgrade code.
file	version.php
	Version information.

Namespaces
	auth_shibboleth
	auth_shibboleth\privacy

Classes
class	auth_plugin_shibboleth
	Shibboleth authentication plugin. More...
class	auth_shibboleth\helper
	The helper class for the Shibboleth authentication plugin. More...
class	auth_shibboleth\privacy\provider
	Privacy Subsystem for auth_shibboleth implementing null_provider. More...
class	auth_shibboleth_admin_setting_special_idp_configtextarea
	Special setting for auth_shibboleth WAYF. More...
class	auth_shibboleth_admin_setting_special_wayf_select
	Special settings for auth_shibboleth WAYF. More...

Functions
	appendCookieValue ($value, $CookieArray)
	Append a value to the array of IDPs. More...
	auth_shibboleth_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
	Serves the logo file settings. More...
	generate_cookie_array ($value)
	Generates an array of IDPs using the cookie value. More...
	generate_cookie_value ($CookieArray)
	Generate the value that is stored in the cookie using the list of IDPs. More...
	get_idp_list ($organization_selection)
	Generate array of IdPs from Moodle Shibboleth settings. More...
	set_saml_cookie ($selectedIDP)
	Sets the standard SAML domain cookie that is also used to preselect the right entry on the local way. More...
	xmldb_auth_shibboleth_upgrade ($oldversion)
	Function to upgrade auth_shibboleth. More...

Variables
$plugin	component = 'auth_shibboleth'
$plugin	requires = 2019111200
$plugin	version = 2019111800

Detailed Description

Function Documentation

appendCookieValue()

appendCookieValue	(		$value,
			$CookieArray
	)

Append a value to the array of IDPs.

Parameters

string	IdP identifier
array	IdP identifiers

Return values

array

IdP identifiers with appended IdP

auth_shibboleth_pluginfile()

auth_shibboleth_pluginfile	(		$course,
			$cm,
			$context,
			$filearea,
			$args,
			$forcedownload,
		array	$options = array()
	)

Serves the logo file settings.

Parameters

stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	context object
string	$filearea	file area
array	$args	extra arguments
bool	$forcedownload	whether or not force download
array	$options	additional options affecting the file serving

Return values

bool	false if file not found, does not return if found - justsend the file

generate_cookie_array()

generate_cookie_array

(

$value

)

Generates an array of IDPs using the cookie value.

Parameters

string

Value of SAML domain cookie

Return values

array

Identifiers of IdPs

generate_cookie_value()

generate_cookie_value

(

$CookieArray

)

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

Parameters

array

IdP identifiers

Return values

string

SAML domain cookie value

get_idp_list()

get_idp_list

(

$organization_selection

)

Generate array of IdPs from Moodle Shibboleth settings.

Parameters

string

Text containing tuble/triple of IdP entityId, name and (optionally) session initiator

Return values

array

Identifier of IdPs and their name/session initiator

set_saml_cookie()

set_saml_cookie

(

$selectedIDP

)

Sets the standard SAML domain cookie that is also used to preselect the right entry on the local way.

Parameters

string

$selectedIDP

IDP identifier

xmldb_auth_shibboleth_upgrade()

xmldb_auth_shibboleth_upgrade

(

$oldversion

)

Function to upgrade auth_shibboleth.

Parameters

int

$oldversion

the version we are upgrading from

Return values

bool

result