ILIAS
release_5-3 Revision v5.3.23-19-g915713cf615
|
Public Member Functions | |
__construct ($authSource) | |
Create an instance with the specified authsource. More... | |
getAuthSource () | |
Retrieve the implementing authentication source. More... | |
isAuthenticated () | |
Check if the user is authenticated. More... | |
requireAuth (array $params=array()) | |
Require the user to be authenticated. More... | |
login (array $params=array()) | |
Start an authentication process. More... | |
logout ($params=null) | |
Log the user out. More... | |
getAttributes () | |
Retrieve attributes of the current user. More... | |
getAuthData ($name) | |
Retrieve authentication data. More... | |
getAuthDataArray () | |
Retrieve all authentication data. More... | |
getLoginURL ($returnTo=null) | |
Retrieve a URL that can be used to log the user in. More... | |
getLogoutURL ($returnTo=null) | |
Retrieve a URL that can be used to log the user out. More... | |
Static Public Member Functions | |
static | logoutCompleted ($state) |
Called when logout operation completes. More... | |
Protected Member Functions | |
getProcessedURL ($url=null) | |
Process a URL and modify it according to the application/baseURL configuration option, if present. More... | |
Protected Attributes | |
$authSource | |
$app_config | |
Definition at line 18 of file Simple.php.
SimpleSAML\Auth\Simple::__construct | ( | $authSource | ) |
Create an instance with the specified authsource.
string | $authSource | The id of the authentication source. |
Definition at line 38 of file Simple.php.
References SimpleSAML\Auth\Simple\$authSource.
SimpleSAML\Auth\Simple::getAttributes | ( | ) |
Retrieve attributes of the current user.
This function will retrieve the attributes of the current user if the user is authenticated. If the user isn't authenticated, it will return an empty array.
Definition at line 258 of file Simple.php.
References $session, array, and SimpleSAML\Auth\Simple\isAuthenticated().
SimpleSAML\Auth\Simple::getAuthData | ( | $name | ) |
Retrieve authentication data.
string | $name | The name of the parameter, e.g. 'Attributes', 'Expire' or 'saml:sp:IdP'. |
Definition at line 279 of file Simple.php.
References $name, $session, and SimpleSAML\Auth\Simple\isAuthenticated().
SimpleSAML\Auth\Simple::getAuthDataArray | ( | ) |
Retrieve all authentication data.
Definition at line 297 of file Simple.php.
References $session, and SimpleSAML\Auth\Simple\isAuthenticated().
SimpleSAML\Auth\Simple::getAuthSource | ( | ) |
Retrieve the implementing authentication source.
Definition at line 54 of file Simple.php.
References $as.
Referenced by SimpleSAML\Auth\Simple\login().
SimpleSAML\Auth\Simple::getLoginURL | ( | $returnTo = null | ) |
Retrieve a URL that can be used to log the user in.
string | null | $returnTo | The page the user should be returned to afterwards. If this parameter is null, the user will be returned to the current page. |
Definition at line 317 of file Simple.php.
References $returnTo, array, and SimpleSAML\Module\getModuleURL().
Referenced by SimpleSAML\Auth\Simple\login().
SimpleSAML\Auth\Simple::getLogoutURL | ( | $returnTo = null | ) |
Retrieve a URL that can be used to log the user out.
string | null | $returnTo | The page the user should be returned to afterwards. If this parameter is null, the user will be returned to the current page. |
Definition at line 342 of file Simple.php.
References $returnTo, array, and SimpleSAML\Module\getModuleURL().
|
protected |
Process a URL and modify it according to the application/baseURL configuration option, if present.
string | null | $url | The URL to process, or null if we want to use the current URL. Both partial and full URLs can be used as a parameter. The maximum precedence is given to the application/baseURL configuration option, then the URL specified (if it specifies scheme, host and port) and finally the environment observed in the server. |
Definition at line 369 of file Simple.php.
References $base, $path, $query, $url, SimpleSAML\Utils\HTTP\getSelfHost(), SimpleSAML\Utils\HTTP\getServerHTTPS(), and SimpleSAML\Utils\HTTP\getServerPort().
SimpleSAML\Auth\Simple::isAuthenticated | ( | ) |
Check if the user is authenticated.
This function checks if the user is authenticated with the default authentication source selected by the 'default-authsource' option in 'config.php'.
Definition at line 72 of file Simple.php.
References $session.
Referenced by SimpleSAML\Auth\Simple\getAttributes(), SimpleSAML\Auth\Simple\getAuthData(), and SimpleSAML\Auth\Simple\getAuthDataArray().
Start an authentication process.
This function accepts an array $params, which controls some parts of the authentication. The accepted parameters depends on the authentication source being used. Some parameters are generic:
Please note: this function never returns.
array | $params | Various options to the authentication request. |
Definition at line 121 of file Simple.php.
References $_POST, $_SERVER, $as, $params, $returnTo, array, SimpleSAML\Auth\Simple\getAuthSource(), SimpleSAML\Auth\Simple\getLoginURL(), SimpleSAML\Utils\HTTP\getPOSTRedirectURL(), and string.
Referenced by SimpleSAML\Auth\Simple\requireAuth().
SimpleSAML\Auth\Simple::logout | ( | $params = null | ) |
Log the user out.
This function logs the user out. It will never return. By default, it will cause a redirect to the current page after logging the user out, but a different URL can be given with the $params parameter.
Generic parameters are:
string | array | null | $params | Either the URL the user should be redirected to after logging out, or an array with parameters for the logout. If this parameter is null, we will return to the current page. |
Definition at line 181 of file Simple.php.
References $as, $params, $session, $state, and array.
|
static |
Called when logout operation completes.
This function never returns.
array | $state | The state after the logout. |
Definition at line 230 of file Simple.php.
References $params, $state, array, and SimpleSAML\Utils\HTTP\redirectTrustedURL().
Require the user to be authenticated.
If the user is authenticated, this function returns immediately.
If the user isn't authenticated, this function will authenticate the user with the authentication source, and then return the user to the current page.
This function accepts an array $params, which controls some parts of the authentication. See the login() method for a description.
array | $params | Various options to the authentication request. See the documentation. |
Definition at line 93 of file Simple.php.
References $params, $session, and SimpleSAML\Auth\Simple\login().
|
protected |
Definition at line 31 of file Simple.php.
|
protected |
Definition at line 26 of file Simple.php.
Referenced by SimpleSAML\Auth\Simple\__construct().