Stud.IP  6.0
StudipAuthShib Class Reference
Inheritance diagram for StudipAuthShib:
StudipAuthSSO StudipAuthAbstract

Public Member Functions

 __construct ($config=[])
 
 getUser ()
 
 verifyUsername ($username)
 
 getUserDomains ()
 
 getUserData ($key)
 
- Public Member Functions inherited from StudipAuthSSO
 getUser ()
 
 isAuthenticated ($username, $password)
 
 isUsedUsername ($username)
 
- Public Member Functions inherited from StudipAuthAbstract
 __construct ($config=[])
 
 authenticateUser ($username, $password)
 
 getStudipUser ($username)
 
 doNewUserInit ($user)
 
 setUserDomains ($user)
 
 getUserDomains ()
 
 doDataMapping ($user)
 
 isMappedField ($name)
 
 verifyUsername ($username)
 
 isUsedUsername ($username)
 
 isAuthenticated ($username, $password)
 
 __isset ($offset)
 
 __set ($offset, $value)
 
 __get ($offset)
 
 __unset ($offset)
 

Data Fields

 $env_remote_user = 'REMOTE_USER'
 
 $local_domain
 
 $session_initiator
 
 $validate_url
 
 $userdata
 
 $username_attribute = 'username'
 
- Data Fields inherited from StudipAuthSSO
 $plugin_fullname
 
 $login_description
 
- Data Fields inherited from StudipAuthAbstract
 $error_msg
 
 $is_new_user = false
 
 $user_domains
 
 $user_data_mapping = null
 
 $plugin_name
 
 $error_head
 
 $show_login
 

Additional Inherited Members

- Static Public Member Functions inherited from StudipAuthAbstract
static getInstance ($plugin_name=false)
 
static isSSOEnabled ()
 
static isLoginEnabled ()
 
static CheckAuthentication ($username, $password)
 
static CheckUsername ($username)
 
static CheckField ($field_name, $plugin_name)
 
static CheckIPRange ()
 
static CheckIPRangeV4 ($ip, $range)
 
static CheckIPRangeV6 ($ip, $range)
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $config = [])

Constructor: read auth information from remote SP.

Member Function Documentation

◆ getUser()

getUser ( )

Return the current username.

◆ getUserData()

getUserData (   $key)

Callback that can be used in user_data_mapping array.

◆ getUserDomains()

getUserDomains ( )

Get the user domains to assign to the current user.

◆ verifyUsername()

verifyUsername (   $username)

Validate the username passed to the auth plugin. Note: This triggers authentication if needed.

Field Documentation

◆ $env_remote_user

$env_remote_user = 'REMOTE_USER'

◆ $local_domain

$local_domain

◆ $session_initiator

$session_initiator

◆ $userdata

$userdata

◆ $username_attribute

$username_attribute = 'username'

◆ $validate_url

$validate_url

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