ilSimpleSAMLphpWrapper Class Reference

Class ilSimpleSAMLphpWrapper. More...

Inheritance diagram for ilSimpleSAMLphpWrapper:

Collaboration diagram for ilSimpleSAMLphpWrapper:

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

Protected Member Functions
	initConfigFiles (string $configurationPath)

Protected Attributes
SimpleSAML Configuration	$config
SimpleSAML Auth Simple	$authSource

Detailed Description

Class ilSimpleSAMLphpWrapper.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

__construct()

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

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

    {
        $this->initConfigFiles($configurationPath);
 
        SimpleSAML\Configuration::setConfigDir($configurationPath);
        $this->config = SimpleSAML\Configuration::getInstance();
 
        $sessionHandler = $this->config->getString('session.handler', false);
        $storageType = $this->config->getString('store.type', false);
 
        if (
            $storageType === 'phpsession' || $sessionHandler === 'phpsession' ||
            (empty($storageType) && empty($sessionHandler))
        ) {
            throw new RuntimeException('Invalid SimpleSAMLphp session handler: Must not be phpsession or empty');
        }
 
        $this->authSource = new SimpleSAML\Auth\Simple($authSourceName);
    }

References initConfigFiles().

Here is the call graph for this function:

Member Function Documentation

getAttributes()

ilSimpleSAMLphpWrapper::getAttributes

(

)

Returns

array

Implements ilSamlAuth.

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

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

getAuthDataArray()

ilSimpleSAMLphpWrapper::getAuthDataArray

(

)

@inheritDoc

Implements ilSamlAuth.

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

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

getAuthId()

ilSimpleSAMLphpWrapper::getAuthId

(

)

Returns

string

Implements ilSamlAuth.

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

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

getIdpDiscovery()

ilSimpleSAMLphpWrapper::getIdpDiscovery

(

)

Returns

ilSamlIdpDiscovery

Implements ilSamlAuth.

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

                                     : ilSamlIdpDiscovery
    {
        return new ilSimpleSAMLphplIdpDiscovery();
    }

getParam()

ilSimpleSAMLphpWrapper::getParam

(

string

$key

)

Parameters

string

$key

Returns

mixed

Implements ilSamlAuth.

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

    {
        $session = SimpleSAML\Session::getSessionFromRequest();
 
        return $session->getData('ilias', $key);
    }

References ILIAS\LTI\ToolProvider\$key, and $session.

Referenced by popParam().

Here is the caller graph for this function:

initConfigFiles()

ilSimpleSAMLphpWrapper::initConfigFiles ( string  $configurationPath )

protected

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

                                                                 : void
    {
        global $DIC;
 
        $templateHandler = new ilSimpleSAMLphpConfigTemplateHandler($DIC->filesystem()->storage());
        $templateHandler->copy('./Services/Saml/lib/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('./Services/Saml/lib/authsources.php.dist', 'auth/saml/config/authsources.php', [
            'RELAY_STATE' => rtrim(ILIAS_HTTP_PATH, '/') . '/saml.php',
            'SP_ENTITY_ID' => rtrim(ILIAS_HTTP_PATH, '/') . '/Services/Saml/lib/metadata.php'
        ]);
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

isAuthenticated()

ilSimpleSAMLphpWrapper::isAuthenticated

(

)

Returns

bool

Implements ilSamlAuth.

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

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

logout()

ilSimpleSAMLphpWrapper::logout

(

string

$returnUrl = ''

)

Parameters

string

$returnUrl

Implements ilSamlAuth.

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

                                                  : void
    {
        ilSession::set('used_external_auth', false);
 
        $params = [
            'ReturnStateParam' => 'LogoutState',
            'ReturnStateStage' => 'ilLogoutState'
        ];
 
        if ($returnUrl !== '') {
            $params['ReturnTo'] = $returnUrl;
        }
 
        $this->authSource->logout($params);
    }

References $params, and ilSession\set().

Here is the call graph for this function:

popParam()

ilSimpleSAMLphpWrapper::popParam

(

string

$key

)

Parameters

string

$key

Returns

mixed

Implements ilSamlAuth.

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

    {
        $session = SimpleSAML\Session::getSessionFromRequest();
        $value = $this->getParam($key);
        $session->deleteData('ilias', $key);
 
        return $value;
    }

References ILIAS\LTI\ToolProvider\$key, $session, and getParam().

Here is the call graph for this function:

protectResource()

ilSimpleSAMLphpWrapper::protectResource

(

)

Protect a script resource with a SAML auth.

Implements ilSamlAuth.

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

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

storeParam()

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

Parameters

string	$key
mixed	$value

Implements ilSamlAuth.

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

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

References ILIAS\LTI\ToolProvider\$key, and $session.

Field Documentation

$authSource

SimpleSAML Auth Simple ilSimpleSAMLphpWrapper::$authSource

protected

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

$config

SimpleSAML Configuration ilSimpleSAMLphpWrapper::$config

protected

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

---

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

• Services/Saml/classes/class.ilSimpleSAMLphpWrapper.php