ilSimpleSAMLphpWrapper Class Reference

Inheritance diagram for ilSimpleSAMLphpWrapper:

Collaboration diagram for ilSimpleSAMLphpWrapper:

Public Member Functions
	__construct (string $authSourceName, string $configurationPath)
	getAuthId ()
	protectResource ()
	Protect a script resource with a SAML auth. More...
	storeParam (string $key, mixed $value)
	getParam (string $key)
	popParam (string $key)
	isAuthenticated ()
	getAttributes ()
	logout (string $returnUrl='')
	getIdpDiscovery ()
	getAuthDataArray ()

Private Member Functions
	initConfigFiles (string $configurationPath)

Private Attributes
const	ILIAS = 'ilias'
SimpleSAML Configuration	$config
SimpleSAML Auth Simple	$authSource

Detailed Description

Definition at line 21 of file class.ilSimpleSAMLphpWrapper.php.

Constructor & Destructor Documentation

__construct()

ilSimpleSAMLphpWrapper::__construct	(	string	$authSourceName,
		string	$configurationPath
	)

Definition at line 28 of file class.ilSimpleSAMLphpWrapper.php.

References initConfigFiles().

    {
        $this->initConfigFiles($configurationPath);

        SimpleSAML\Configuration::setConfigDir($configurationPath);
        $this->config = SimpleSAML\Configuration::getInstance();

        $storageType = $this->config->getString('store.type');

        if (in_array($storageType, ['phpsession', ''], true)) {
            throw new RuntimeException('Invalid SimpleSAMLphp session handler: Must not be phpsession or empty');
        }

        $this->authSource = new SimpleSAML\Auth\Simple($authSourceName);
    }

Here is the call graph for this function:

Member Function Documentation

getAttributes()

ilSimpleSAMLphpWrapper::getAttributes

(

)

Implements ilSamlAuth.

Definition at line 100 of file class.ilSimpleSAMLphpWrapper.php.

                                   : array
    {
        return $this->authSource->getAttributes();
    }

getAuthDataArray()

ilSimpleSAMLphpWrapper::getAuthDataArray

(

)

Implements ilSamlAuth.

Definition at line 126 of file class.ilSimpleSAMLphpWrapper.php.

                                      : array
    {
        return $this->authSource->getAuthDataArray();
    }

getAuthId()

ilSimpleSAMLphpWrapper::getAuthId

(

)

Implements ilSamlAuth.

Definition at line 63 of file class.ilSimpleSAMLphpWrapper.php.

                               : string
    {
        return $this->authSource->getAuthSource()->getAuthId();
    }

getIdpDiscovery()

ilSimpleSAMLphpWrapper::getIdpDiscovery

(

)

Implements ilSamlAuth.

Definition at line 121 of file class.ilSimpleSAMLphpWrapper.php.

                                     : ilSamlIdpDiscovery
    {
        return new ilSimpleSAMLphplIdpDiscovery();
    }

getParam()

ilSimpleSAMLphpWrapper::getParam

(

string

$key

)

Returns

mixed

Implements ilSamlAuth.

Definition at line 79 of file class.ilSimpleSAMLphpWrapper.php.

Referenced by popParam().

    {
        $session = SimpleSAML\Session::getSessionFromRequest();

        return $session->getData(self::ILIAS, $key);
    }

Here is the caller graph for this function:

initConfigFiles()

ilSimpleSAMLphpWrapper::initConfigFiles ( string  $configurationPath )

private

Definition at line 44 of file class.ilSimpleSAMLphpWrapper.php.

References $DIC, ilSimpleSAMLphpConfigTemplateHandler\copy(), ilPasswordUtils\getBytes(), ilLoggingDBSettings\getInstance(), and IL_COOKIE_PATH.

Referenced by __construct().

                                                               : void
    {
        global $DIC;

        $templateHandler = new ilSimpleSAMLphpConfigTemplateHandler($DIC->filesystem()->storage());
        $templateHandler->copy('../components/ILIAS/Saml/resources/config.php.dist', 'auth/saml/config/config.php', [
            'DB_PATH' => rtrim($configurationPath, '/') . '/ssphp.sq3',
            'SQL_INITIAL_PASSWORD' => static function (): string {
                return substr(str_replace('+', '.', base64_encode(ilPasswordUtils::getBytes(20))), 0, 10);
            },
            'COOKIE_PATH' => IL_COOKIE_PATH,
            'LOG_DIRECTORY' => ilLoggingDBSettings::getInstance()->getLogDir()
        ]);
        $templateHandler->copy('../components/ILIAS/Saml/resources/authsources.php.dist', 'auth/saml/config/authsources.php', [
            'RELAY_STATE' => rtrim(ILIAS_HTTP_PATH, '/') . '/saml.php',
            'SP_ENTITY_ID' => rtrim(ILIAS_HTTP_PATH, '/') . '/metadata.php'
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAuthenticated()

ilSimpleSAMLphpWrapper::isAuthenticated

(

)

Implements ilSamlAuth.

Definition at line 95 of file class.ilSimpleSAMLphpWrapper.php.

                                     : bool
    {
        return $this->authSource->isAuthenticated();
    }

logout()

ilSimpleSAMLphpWrapper::logout

(

string

$returnUrl = ''

)

Implements ilSamlAuth.

Definition at line 105 of file class.ilSimpleSAMLphpWrapper.php.

References $params, and ilSession\clear().

                                                  : void
    {
        ilSession::clear('used_external_auth_mode');

        $params = [
            'ReturnStateParam' => 'LogoutState',
            'ReturnStateStage' => 'ilLogoutState'
        ];

        if ($returnUrl !== '') {
            $params['ReturnTo'] = $returnUrl;
        }

        $this->authSource->logout($params);
    }

Here is the call graph for this function:

popParam()

ilSimpleSAMLphpWrapper::popParam

(

string

$key

)

Returns

mixed

Implements ilSamlAuth.

Definition at line 86 of file class.ilSimpleSAMLphpWrapper.php.

References getParam().

    {
        $session = SimpleSAML\Session::getSessionFromRequest();
        $value = $this->getParam($key);
        $session->deleteData(self::ILIAS, $key);

        return $value;
    }

Here is the call graph for this function:

protectResource()

ilSimpleSAMLphpWrapper::protectResource

(

)

Protect a script resource with a SAML auth.

Implements ilSamlAuth.

Definition at line 68 of file class.ilSimpleSAMLphpWrapper.php.

                                     : void
    {
        $this->authSource->requireAuth();
    }

storeParam()

ilSimpleSAMLphpWrapper::storeParam	(	string	$key,
		mixed	$value
	)

Implements ilSamlAuth.

Definition at line 73 of file class.ilSimpleSAMLphpWrapper.php.

                                                         : void
    {
        $session = SimpleSAML\Session::getSessionFromRequest();
        $session->setData(self::ILIAS, $key, $value);
    }

Field Documentation

$authSource

SimpleSAML Auth Simple ilSimpleSAMLphpWrapper::$authSource

private

Definition at line 26 of file class.ilSimpleSAMLphpWrapper.php.

$config

SimpleSAML Configuration ilSimpleSAMLphpWrapper::$config

private

Definition at line 25 of file class.ilSimpleSAMLphpWrapper.php.

ILIAS

const ilSimpleSAMLphpWrapper::ILIAS = 'ilias'

private

Definition at line 23 of file class.ilSimpleSAMLphpWrapper.php.

---

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

• components/ILIAS/Saml/classes/class.ilSimpleSAMLphpWrapper.php