SimpleSAML\Utils\Auth Class Reference

Inheritance diagram for SimpleSAML\Utils\Auth:

Collaboration diagram for SimpleSAML\Utils\Auth:

Static Public Member Functions
static	getAdminLoginURL ($returnTo=null)
	Retrieve a admin login URL. More...
static	isAdmin ()
	Check whether the current user is admin. More...
static	requireAdmin ()
	Require admin access to the current page. More...

Detailed Description

Definition at line 11 of file Auth.php.

Member Function Documentation

getAdminLoginURL()

static SimpleSAML\Utils\Auth::getAdminLoginURL (   $returnTo = null )

static

Retrieve a admin login URL.

Parameters

string | NULL

$returnTo

The URL the user should arrive on after admin authentication. Defaults to null.

Returns

string A URL which can be used for admin authentication.

Exceptions

Definition at line 22 of file Auth.php.

References $returnTo, array, and SimpleSAML\Module\getModuleURL().

Referenced by SimpleSAML_Utilities\getAdminLoginURL().

    {
        if (!(is_string($returnTo) || is_null($returnTo))) {
            throw new \InvalidArgumentException('Invalid input parameters.');
        }

        if ($returnTo === null) {
            $returnTo = HTTP::getSelfURL();
        }

        return Module::getModuleURL('core/login-admin.php', array('ReturnTo' => $returnTo));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAdmin()

static SimpleSAML\Utils\Auth::isAdmin ( )

static

Check whether the current user is admin.

Returns

boolean True if the current user is an admin user, false otherwise.

Author

Olav Morken, UNINETT AS olav..nosp@m.mork.nosp@m.en@un.nosp@m.inet.nosp@m.t.no

Definition at line 42 of file Auth.php.

References $session, and SimpleSAML_Session\getSessionFromRequest().

Referenced by SimpleSAML_Utilities\isAdmin().

    {
        $session = \SimpleSAML_Session::getSessionFromRequest();
        return $session->isValid('admin') || $session->isValid('login-admin');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

requireAdmin()

static SimpleSAML\Utils\Auth::requireAdmin ( )

static

Require admin access to the current page.

This is a helper function for limiting a page to those with administrative access. It will redirect the user to a login page if the current user doesn't have admin access.

Returns

void This function will only return if the user is admin.

Exceptions

Definition at line 60 of file Auth.php.

References $as, and SimpleSAML_Auth_Source\getById().

Referenced by sspmod_statistics_AccessCheck\checkAccess(), and SimpleSAML_Utilities\requireAdmin().

    {
        if (self::isAdmin()) {
            return;
        }

        // not authenticated as admin user, start authentication
        if (\SimpleSAML_Auth_Source::getById('admin') !== null) {
            $as = new \SimpleSAML\Auth\Simple('admin');
            $as->login();
        } else {
            throw new \SimpleSAML_Error_Exception(
                'Cannot find "admin" auth source, and admin privileges are required.'
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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