SimpleSAML_Auth_Default Class Reference

Collaboration diagram for SimpleSAML_Auth_Default:

Static Public Member Functions
static	initLogin ($authId, $return, $errorURL=NULL, array $params=array())
static	extractPersistentAuthState (array &$state)
static	loginCompleted ($state)
static	initLogoutReturn ($returnURL, $authority)
static	initLogout ($returnURL, $authority)
static	logoutCompleted ($state)
static	logoutCallback ($state)
static	handleUnsolicitedAuth ($authId, array $state, $redirectTo)

Static Private Member Functions
static	getAuthSource ($id)
	Return an authentication source by ID. More...

Detailed Description

Definition at line 14 of file Default.php.

Member Function Documentation

extractPersistentAuthState()

static SimpleSAML_Auth_Default::extractPersistentAuthState ( array &  $state )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML_Auth_State::getPersistentAuthData() instead.

Definition at line 32 of file Default.php.

References SimpleSAML_Auth_State\getPersistentAuthData().

                                                                         {

                return SimpleSAML_Auth_State::getPersistentAuthData($state);
        }

Here is the call graph for this function:

getAuthSource()

static SimpleSAML_Auth_Default::getAuthSource (   $id )

staticprivate

Return an authentication source by ID.

Parameters

string

$id

The id of the authentication source.

Returns

SimpleSAML_Auth_Source The authentication source.

Exceptions

Exception

If the $id does not correspond with an authentication source.

Definition at line 119 of file Default.php.

References $as, $id, and SimpleSAML_Auth_Source\getById().

                                                   {
                $as = SimpleSAML_Auth_Source::getById($id);
                if ($as === null) {
                        throw new Exception('Invalid authentication source: ' . $id);
                }
                return $as;
        }

Here is the call graph for this function:

handleUnsolicitedAuth()

static SimpleSAML_Auth_Default::handleUnsolicitedAuth (   $authId, array  $state,   $redirectTo  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use sspmod_saml_Auth_Source_SP::handleUnsolicitedAuth() instead.

Definition at line 107 of file Default.php.

References sspmod_saml_Auth_Source_SP\handleUnsolicitedAuth().

                                                                                         {
                sspmod_saml_Auth_Source_SP::handleUnsolicitedAuth($authId, $state, $redirectTo);
        }

Here is the call graph for this function:

initLogin()

static SimpleSAML_Auth_Default::initLogin (   $authId,   $return,   $errorURL = NULL, array  $params = array()  )

static

Deprecated:

This method will be removed in SSP 2.0.

Use SimpleSAML_Auth_Source::initLogin() instead.

Definition at line 20 of file Default.php.

References $as, and $params.

                                         {

                $as = self::getAuthSource($authId);
                $as->initLogin($return, $errorURL, $params);
        }

initLogout()

static SimpleSAML_Auth_Default::initLogout (   $returnURL,   $authority  )

static

Deprecated:

This method will be removed in SSP 2.0.

Definition at line 74 of file Default.php.

References $authority, and SimpleSAML\Utils\HTTP\redirectTrustedURL().

                                                                  {
                assert('is_string($returnURL)');
                assert('is_string($authority)');

                self::initLogoutReturn($returnURL, $authority);

                \SimpleSAML\Utils\HTTP::redirectTrustedURL($returnURL);
        }

Here is the call graph for this function:

initLogoutReturn()

static SimpleSAML_Auth_Default::initLogoutReturn (   $returnURL,   $authority  )

static

Deprecated:

This method will be removed in SSP 2.0.

Definition at line 49 of file Default.php.

References $as, $authority, $session, $state, array, SimpleSAML_Auth_Source\getById(), and SimpleSAML_Session\getSessionFromRequest().

                                                                        {
                assert('is_string($returnURL)');
                assert('is_string($authority)');

                $session = SimpleSAML_Session::getSessionFromRequest();

                $state = $session->getAuthData($authority, 'LogoutState');
                $session->doLogout($authority);

                $state['SimpleSAML_Auth_Default.ReturnURL'] = $returnURL;
                $state['LogoutCompletedHandler'] = array(get_class(), 'logoutCompleted');

                $as = SimpleSAML_Auth_Source::getById($authority);
                if ($as === NULL) {
                        // The authority wasn't an authentication source...
                        self::logoutCompleted($state);
                }

                $as->logout($state);
        }

Here is the call graph for this function:

loginCompleted()

static SimpleSAML_Auth_Default::loginCompleted (   $state )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML_Auth_Source::loginCompleted() instead.

Definition at line 41 of file Default.php.

References $state, and SimpleSAML_Auth_Source\loginCompleted().

                                                      {
                SimpleSAML_Auth_Source::loginCompleted($state);
        }

Here is the call graph for this function:

logoutCallback()

static SimpleSAML_Auth_Default::logoutCallback (   $state )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML_Auth_Source::logoutCallback() instead.

Definition at line 98 of file Default.php.

References $state, and SimpleSAML_Auth_Source\logoutCallback().

                                                      {
                SimpleSAML_Auth_Source::logoutCallback($state);
        }

Here is the call graph for this function:

logoutCompleted()

static SimpleSAML_Auth_Default::logoutCompleted (   $state )

static

Deprecated:

This method will be removed in SSP 2.0.

Definition at line 87 of file Default.php.

References $state, and SimpleSAML\Utils\HTTP\redirectTrustedURL().

                                                       {
                assert('is_array($state)');
                assert('array_key_exists("SimpleSAML_Auth_Default.ReturnURL", $state)');

                \SimpleSAML\Utils\HTTP::redirectTrustedURL($state['SimpleSAML_Auth_Default.ReturnURL']);
        }

Here is the call graph for this function:

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Auth/Default.php