Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
StudipAuthOIDC Class Reference
Inheritance diagram for StudipAuthOIDC:
StudipAuthSSO StudipAuthAbstract

Public Member Functions

 __construct ($config=[])
 
 verifyUsername ($username)
 
 getUser ()
 
 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

 $provider_url
 
 $client_id
 
 $client_secret
 
- 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
 

Additional Inherited Members

- Static Public Member Functions inherited from StudipAuthAbstract
static getInstance ($plugin_name=false)
 
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 (   $config = [])
Parameters
array$config

Member Function Documentation

getUser ( )

Return the current username of the pending authentication request.

getUserData (   $key)

Callback that can be used in user_data_mapping array.

See Also
https://openid.net/specs/openid-connect-basic-1_0.html#StandardClaims
Parameters
stringkey
Returns
string parameter value (null if not set)
getUserDomains ( )

Get the user domains to assign to the current user (if any).

Returns
array array of user domain names
verifyUsername (   $username)

Validate the username passed to the auth plugin.

Parameters
string$username
Returns
string username openid attribute user_id
Exceptions
OpenIDConnectClientException

Field Documentation

$client_id
$client_secret
$provider_url

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