class.ilSimpleSAMLphpWrapper.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

final readonly class ilSimpleSAMLphpWrapper implements ilSamlAuth
{
    private const string ILIAS = 'ilias';

    private SimpleSAML\Configuration $config;
    private SimpleSAML\Auth\Simple $authSource;

    public function __construct(string $authSourceName, string $configurationPath)
    {
        $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);
    }

    private function initConfigFiles(string $configurationPath): 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'
        ]);
    }

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

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

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

    public function getParam(string $key)
    {
        $session = SimpleSAML\Session::getSessionFromRequest();

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

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

        return $value;
    }

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

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

    public function logout(string $returnUrl = ''): void
    {
        ilSession::clear('used_external_auth_mode');

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

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

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

    public function getIdpDiscovery(): ilSamlIdpDiscovery
    {
        return new ilSimpleSAMLphplIdpDiscovery();
    }

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