modules/Users/authentication/SAMLAuthenticate/SAMLAuthenticate.php
inherited
Classes
\SAMLAuthenticate
This file is used to control the authentication process.
It will call on the user authenticate and controll redirection based on the users validation
- Parent(s)
- \SugarAuthenticate
Properties
$authenticationDir= ''SAMLAuthenticate''
'SAMLAuthenticate'Details- Type
- n/a
$userAuthenticateClass= ''SAMLAuthenticateUser''
'SAMLAuthenticateUser'Details- Type
- n/a
Methods
SAMLAuthenticate(
)
:
\SAMLAuthenticateConstructs SAMLAuthenticate This will load the user authentication class
| Type | Description |
|---|---|
| \SAMLAuthenticate |
SugarAuthenticate(
)
:
\SugarAuthenticateConstructs SugarAuthenticate This will load the user authentication class
Inherited from: \SugarAuthenticate::SugarAuthenticate()| Type | Description |
|---|---|
| \SugarAuthenticate |
canChangePassword(
)
:
voidIf a user may change there password through the Sugar UI
Inherited from: \SugarAuthenticate::canChangePassword()canChangeUserName(
)
:
voidIf a user may change there user name through the Sugar UI
Inherited from: \SugarAuthenticate::canChangeUserName()encodePassword(
STRING $password
)
:
STRINGEncodes a users password. This is a static function and can be called at any time.
Inherited from: \SugarAuthenticate::encodePassword()| Name | Type | Description |
|---|---|---|
| $password | STRING |
| Type | Description |
|---|---|
| STRING | $encoded_password |
loginAuthenticate(
string $username, string $password, $fallback
=
false, $PARAMS
=
array ()
)
:
booleanAuthenticates a user based on the username and password returns true if the user was authenticated false otherwise it also will load the user into current user if he was authenticated
Inherited from: \SugarAuthenticate::loginAuthenticate()| Name | Type | Description |
|---|---|---|
| $username | string | |
| $password | string | |
| $fallback | ||
| $PARAMS |
| Type | Description |
|---|---|
| boolean |
logout(
)
:
voidCalled when a user requests to logout
Override default behavior. Redirect user to special "Logged Out" page in order to prevent automatic logging in.
postLoginAuthenticate(
)
:
voidOnce a user is authenticated on login this function will be called. Populate the session with what is needed and log anything that needs to be logged
Inherited from: \SugarAuthenticate::postLoginAuthenticate()postSessionAuthenticate(
)
:
booleanCalled after a session is authenticated - if this returns false the sessionAuthenticate will return false and destroy the session and it will load the current user
Inherited from: \SugarAuthenticate::postSessionAuthenticate()| Type | Description |
|---|---|
| boolean |
pre_login(
)
:
voidpre_login
Override the pre_login function from SugarAuthenticate so that user is redirected to SAML entry point if other is not specified
sessionAuthenticate(
)
:
booleanOn every page hit this will be called to ensure a user is authenticated
Inherited from: \SugarAuthenticate::sessionAuthenticate()| Type | Description |
|---|---|
| boolean |
validateIP(
)
:
voidMake sure a user isn't stealing sessions so check the ip to ensure that the ip address hasn't dramatically changed
Inherited from: \SugarAuthenticate::validateIP()