[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/auth/shibboleth/ -> auth.php (summary)

Authentication Plugin: Shibboleth Authentication Authentication using Shibboleth. Distributed under GPL (c)Markus Hagman 2004-2006

Author: Martin Dougiamas
Author: Lukas Haemmerle
License: http://www.gnu.org/copyleft/gpl.html GNU Public License
File Size: 459 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 auth/shibboleth/config.html

Defines 1 class

auth_plugin_shibboleth:: (19 methods):
  __construct()
  auth_plugin_shibboleth()
  user_login()
  get_userinfo()
  get_attributes()
  prevent_local_passwords()
  is_internal()
  can_change_password()
  loginpage_hook()
  logoutpage_hook()
  config_form()
  process_config()
  get_first_string()
  set_saml_cookie()
  print_idp_list()
  get_idp_list()
  generate_cookie_array()
  generate_cookie_value()
  appendCookieValue()


Class: auth_plugin_shibboleth  - X-Ref

Shibboleth authentication plugin.

__construct()   X-Ref
Constructor.


auth_plugin_shibboleth()   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


user_login($username, $password)   X-Ref
Returns true if the username and password work and false if they are
wrong or don't exist.

param: string $username The username (with system magic quotes)
param: string $password The password (with system magic quotes)
return: bool Authentication success or failure.

get_userinfo($username)   X-Ref
Returns the user information for 'external' users. In this case the
attributes provided by Shibboleth

return: array $result Associative array of user data

get_attributes()   X-Ref
Returns array containg attribute mappings between Moodle and Shibboleth.

return: array

prevent_local_passwords()   X-Ref
No description

is_internal()   X-Ref
Returns true if this authentication plugin is 'internal'.

return: bool

can_change_password()   X-Ref
Returns true if this authentication plugin can change the user's
password.

return: bool

loginpage_hook()   X-Ref
Hook for login page


logoutpage_hook()   X-Ref
Hook for logout page


config_form($config, $err, $user_fields)   X-Ref
Prints a form for configuring this authentication plugin.

This function is called from admin/auth.php, and outputs a full page with
a form for configuring this plugin.

param: array $page An object containing all the data for this page.

process_config($config)   X-Ref
Processes and stores configuration data for this authentication plugin.

param: object $config Configuration object

get_first_string($string)   X-Ref
Cleans and returns first of potential many values (multi-valued attributes)

param: string $string Possibly multi-valued attribute from Shibboleth

set_saml_cookie($selectedIDP)   X-Ref
Sets the standard SAML domain cookie that is also used to preselect
the right entry on the local wayf

param: IdP identifiere

print_idp_list()   X-Ref
Prints the option elements for the select element of the drop down list


get_idp_list($organization_selection)   X-Ref
Generate array of IdPs from Moodle Shibboleth settings

param: string Text containing tuble/triple of IdP entityId, name and (optionally) session initiator
return: array Identifier of IdPs and their name/session initiator

generate_cookie_array($value)   X-Ref
Generates an array of IDPs using the cookie value

param: string Value of SAML domain cookie
return: array Identifiers of IdPs

generate_cookie_value($CookieArray)   X-Ref
Generate the value that is stored in the cookie using the list of IDPs

param: array IdP identifiers
return: string SAML domain cookie value

appendCookieValue($value, $CookieArray)   X-Ref
Append a value to the array of IDPs

param: string IdP identifier
param: array IdP identifiers
return: array IdP identifiers with appended IdP



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1