ILIAS
release_4-4 Revision
|
Public Member Functions | |
__construct ($authParams, $updateUserData=false) | |
supportsRedirects () | |
setIdle ($time, $add=false) | |
Deletes a role and deletes entries in object_data, rbac_pa, rbac_templates, rbac_ua, rbac_fa. More... | |
setExpire ($time, $add=false) | |
Set the maximum expire time. More... | |
login () | |
Login function. More... | |
setAuth ($username, ilObjUser $userObj=NULL) | |
logout () | |
Logout function. More... | |
generateLogin () | |
Automatically generates the username/screenname of a Shibboleth user or returns the user's already existing username. More... | |
![]() | |
Auth ($storageDriver, $options='', $loginFunction='', $showLogin=true) | |
Constructor. More... | |
& | applyAuthOptions (&$options) |
Set the Auth options. More... | |
_loadStorage () | |
Load Storage Driver if not already loaded. More... | |
assignData () | |
Assign data from login form to internal values. More... | |
start () | |
Start new auth session. More... | |
login () | |
Login function. More... | |
setExpire ($time, $add=false) | |
Set the maximum expire time. More... | |
setIdle ($time, $add=false) | |
Set the maximum idle time. More... | |
setSessionName ($name='session') | |
Set name of the session to a customized value. More... | |
setShowLogin ($showLogin=true) | |
Should the login form be displayed if neccessary? More... | |
setAllowLogin ($allowLogin=true) | |
Should the login form be displayed if neccessary? More... | |
setCheckAuthCallback ($checkAuthCallback) | |
Register a callback function to be called whenever the validity of the login is checked The function will receive two parameters, the username and a reference to the auth object. More... | |
setLoginCallback ($loginCallback) | |
Register a callback function to be called on user login. More... | |
setFailedLoginCallback ($loginFailedCallback) | |
Register a callback function to be called on failed user login. More... | |
setLogoutCallback ($logoutCallback) | |
Register a callback function to be called on user logout. More... | |
setAuthData ($name, $value, $overwrite=true) | |
Register additional information that is to be stored in the session. More... | |
getAuthData ($name=null) | |
Get additional information that is stored in the session. More... | |
setAuth ($username) | |
Register variable in a session telling that the user has logged in successfully. More... | |
setAdvancedSecurity ($flag=true) | |
Enables advanced security checks. More... | |
checkAuth () | |
Checks if there is a session with valid auth information. More... | |
getAuth () | |
Has the user been authenticated? More... | |
logout () | |
Logout function. More... | |
updateIdle () | |
Update the idletime. More... | |
getUsername () | |
Get the username. More... | |
getStatus () | |
Get the current status. More... | |
getPostUsernameField () | |
Gets the post varible used for the username. More... | |
getPostPasswordField () | |
Gets the post varible used for the username. More... | |
sessionValidThru () | |
Returns the time up to the session is valid. More... | |
listUsers () | |
List all users that are currently available in the storage container. More... | |
addUser ($username, $password, $additional='') | |
Add user to the storage container. More... | |
removeUser ($username) | |
Remove user from the storage container. More... | |
changePassword ($username, $password) | |
Change password for user in the storage container. More... | |
log ($message, $level=AUTH_LOG_DEBUG) | |
Log a message from the Auth system. More... | |
_loadLogger () | |
Load Log object if not already loaded. More... | |
attachLogObserver (&$observer) | |
Attach an Observer to the Auth Log Source. More... | |
_isAdvancedSecurityEnabled ($feature=null) | |
Is advanced security enabled? More... | |
![]() | |
supportsRedirects () | |
Returns true, if the current auth mode allows redirects to e.g the login screen, public section ... More... | |
getContainer () | |
Get container object. More... | |
getExceededUserName () | |
Static Public Member Functions | |
static | toAscii ($string) |
Replaces any non-ASCII character by its linguistically most logical substitution. More... | |
![]() | |
& | _factory ($driver, $options='') |
Return a storage driver based on $driver and $options. More... | |
staticCheckAuth ($options=null) | |
Statically checks if there is a session with valid auth information. More... | |
Data Fields | |
$username | |
$_sessionName = '_authsession' | |
$status = '' | |
$expire = 0 | |
$idle = 0 | |
$idled = false | |
![]() | |
$expire = 0 | |
$expired = false | |
$idle = 0 | |
$idled = false | |
$storage = '' | |
$loginFunction = '' | |
$showLogin = true | |
$allowLogin = true | |
$status = '' | |
$username = '' | |
$password = '' | |
$checkAuthCallback = '' | |
$loginCallback = '' | |
$loginFailedCallback = '' | |
$logoutCallback = '' | |
$_sessionName = '_authsession' | |
$version = "@version@" | |
$advancedsecurity = false | |
$_postUsername = 'username' | |
$_postPassword = 'password' | |
$session | |
$server | |
$post | |
$cookie | |
$authdata | |
$authChecks = 0 | |
$logger = null | |
$enableLogging = false | |
$regenerateSessionId = false | |
Static Private Member Functions | |
static | getFirstString ($string) |
Cleans and returns first of potential many values (multi-valued attributes) More... | |
Additional Inherited Members | |
![]() | |
initAuth () | |
Init auth object Enable logging, set callbacks... More... | |
loginObserver ($a_username, $a_auth) | |
Called after successful login. More... | |
failedLoginObserver ($a_username, $a_auth) | |
Called after failed login. More... | |
checkAuthObserver ($a_username, $a_auth) | |
Called after each check auth request. More... | |
logoutObserver ($a_username, $a_auth) | |
Called after logout. More... | |
![]() | |
$sub_status = null | |
$exceeded_user_name | |
Definition at line 40 of file class.ilShibboleth.php.
ShibAuth::__construct | ( | $authParams, | |
$updateUserData = false |
|||
) |
$authParams | ||
bool | $updateUserData |
Definition at line 93 of file class.ilShibboleth.php.
References Auth\setSessionName().
ShibAuth::generateLogin | ( | ) |
Automatically generates the username/screenname of a Shibboleth user or returns the user's already existing username.
private
Definition at line 368 of file class.ilShibboleth.php.
References ilObjUser\_checkExternalAuthAccount(), ilUtil\generatePasswords(), ilObjUser\getUserIdByLogin(), and toAscii().
Referenced by login().
|
staticprivate |
Cleans and returns first of potential many values (multi-valued attributes)
private
A | $string |
Definition at line 441 of file class.ilShibboleth.php.
ShibAuth::login | ( | ) |
Login function.
private
Definition at line 162 of file class.ilShibboleth.php.
References $_GET, $ilSetting, $username, ilObjUser\_updateLastLogin(), AUTH_WRONG_LOGIN, ilShibbolethRoleAssignmentRules\doAssignments(), generateLogin(), ilUtil\generatePasswords(), ilShibbolethPluginWrapper\getInstance(), ilObjUser\getUserIdByLogin(), IL_PASSWD_MD5, ilUtil\redirect(), setAuth(), and ilShibbolethRoleAssignmentRules\updateAssignments().
ShibAuth::logout | ( | ) |
Logout function.
This function clears any auth tokens in the currently active session and executes the logout callback function, if any
public
Definition at line 353 of file class.ilShibboleth.php.
References $ilUser, and ilShibbolethPluginWrapper\getInstance().
ShibAuth::setAuth | ( | $username, | |
ilObjUser | $userObj = NULL |
||
) |
$username | ||
ilObjUser | $userObj |
Definition at line 332 of file class.ilShibboleth.php.
References ilShibbolethPluginWrapper\getInstance().
Referenced by login().
ShibAuth::setExpire | ( | $time, | |
$add = false |
|||
) |
Set the maximum expire time.
public
integer | time in seconds |
bool | add time to current expire time or not |
Definition at line 147 of file class.ilShibboleth.php.
ShibAuth::setIdle | ( | $time, | |
$add = false |
|||
) |
Deletes a role and deletes entries in object_data, rbac_pa, rbac_templates, rbac_ua, rbac_fa.
public
$time | ||
bool | $add |
Definition at line 128 of file class.ilShibboleth.php.
ShibAuth::supportsRedirects | ( | ) |
|
static |
Replaces any non-ASCII character by its linguistically most logical substitution.
private
A | $string |
Definition at line 462 of file class.ilShibboleth.php.
References UtfNormal\toNFKD().
Referenced by generateLogin().
ShibAuth::$_sessionName = '_authsession' |
Definition at line 53 of file class.ilShibboleth.php.
ShibAuth::$expire = 0 |
Definition at line 68 of file class.ilShibboleth.php.
ShibAuth::$idle = 0 |
Definition at line 79 of file class.ilShibboleth.php.
ShibAuth::$idled = false |
Definition at line 86 of file class.ilShibboleth.php.
ShibAuth::$status = '' |
Definition at line 59 of file class.ilShibboleth.php.
ShibAuth::$username |
Definition at line 47 of file class.ilShibboleth.php.
Referenced by login().