class.ilAuthProviderSaml.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\User\Profile\Profile;
 
class ilAuthProviderSaml extends ilAuthProvider implements ilAuthProviderAccountMigrationInterface
{
    private const string LOG_COMPONENT = 'auth';
 
    private const string ERR_WRONG_LOGIN = 'err_wrong_login';
    private const string ERR_PROVIDER_INACTIVE = 'auth_saml_idp_deactivated_auth_failed';
 
    private const string SESSION_TMP_ATTRIBUTES = 'tmp_attributes';
    private const string SESSION_TMP_RETURN_TO = 'tmp_return_to';
 
    private ilSamlIdp $idp;
    private readonly ilLanguage $lng;
    private readonly Profile $profile;
    private array $attributes = [];
    private string $return_to = '';
    private string $uid = '';
    private bool $force_new_account = false;
    private string $migration_account = '';
    private ?array $user_defined_fields = null;
 
    public function __construct(ilAuthCredentials $credentials, ?int $a_idp_id = null)
    {
        global $DIC;
 
        parent::__construct($credentials);
 
        $this->lng = $DIC->language();
        $this->profile = $DIC['user']->getProfile();
 
        if (null === $a_idp_id || 0 === $a_idp_id) {
            $this->idp = ilSamlIdp::getFirstActiveIdp();
        } else {
            $this->idp = ilSamlIdp::getInstanceByIdpId($a_idp_id);
        }
 
        if ($credentials instanceof ilAuthFrontendCredentialsSaml) {
            $this->attributes = $credentials->getAttributes();
            $this->return_to = $credentials->getReturnTo();
        }
    }
 
    private function determineUidFromAttributes(): void
    {
        if (
            !array_key_exists($this->idp->getUidClaim(), $this->attributes) ||
            !is_array($this->attributes[$this->idp->getUidClaim()]) ||
            !array_key_exists(0, $this->attributes[$this->idp->getUidClaim()]) ||
            $this->attributes[$this->idp->getUidClaim()][0] === ''
        ) {
            throw new ilException(sprintf(
                'Could not find unique SAML attribute for the configured identifier: %s',
                print_r($this->idp->getUidClaim(), true)
            ));
        }
 
        $this->uid = $this->attributes[$this->idp->getUidClaim()][0];
    }
 
    public function doAuthentication(ilAuthStatus $status): bool
    {
        if (!$this->idp->isActive()) {
            $this->getLogger()->info(
                'SAML IdP with id {idp_id} is not active.',
                ['idp_id' => $this->idp->getIdpId()]
            );
            $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $status->setTranslatedReason($this->lng->txt(self::ERR_PROVIDER_INACTIVE));
            return false;
        }
 
        if ([] === $this->attributes) {
            $this->getLogger()->warning('Could not parse any attributes from SAML response.');
            $this->handleAuthenticationFail($status, self::ERR_WRONG_LOGIN);
 
            return false;
        }
 
        try {
            $this->determineUidFromAttributes();
 
            return $this->handleSamlAuth($status);
        } catch (Exception $e) {
            $this->getLogger()->warning($e->getMessage());
            $this->handleAuthenticationFail($status, self::ERR_WRONG_LOGIN);
 
            return false;
        }
    }
 
    private function handleSamlAuth(ilAuthStatus $status): bool
    {
        $update_auth_mode = false;
 
        ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
            'Login observer called for SAML authentication request of ext_account "%s" and auth_mode "%s".',
            $this->uid,
            $this->getUserAuthModeName()
        ));
        ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf('Target set to: %s', print_r($this->return_to, true)));
        ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
            'Trying to find ext_account "%s" for auth_mode "%s".',
            $this->uid,
            $this->getUserAuthModeName()
        ));
 
        $internal_account = ilObjUser::_checkExternalAuthAccount(
            $this->getUserAuthModeName(),
            $this->uid,
            false
        );
 
        if (!is_string($internal_account) || $internal_account === '') {
            $update_auth_mode = true;
 
            ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                'Could not find ext_account "%s" for auth_mode "%s".',
                $this->uid,
                $this->getUserAuthModeName()
            ));
 
            $fallback_auth_mode = 'local';
            ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                'Trying to find ext_account "%s" for auth_mode "%s".',
                $this->uid,
                $fallback_auth_mode
            ));
            $internal_account = ilObjUser::_checkExternalAuthAccount($fallback_auth_mode, $this->uid, false);
 
            $defaultAuth = ilAuthUtils::AUTH_LOCAL;
            if ($GLOBALS['DIC']['ilSetting']->get('auth_mode')) {
                $defaultAuth = $GLOBALS['DIC']['ilSetting']->get('auth_mode');
            }
 
            if (
                (!is_string($internal_account) || $internal_account === '') &&
                ($defaultAuth == ilAuthUtils::AUTH_LOCAL || $defaultAuth == $this->getTriggerAuthMode())
            ) {
                ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                    'Could not find ext_account "%s" for auth_mode "%s".',
                    $this->uid,
                    $fallback_auth_mode
                ));
 
                $fallback_auth_mode = 'default';
                ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                    'Trying to find ext_account "%s" for auth_mode "%s".',
                    $this->uid,
                    $fallback_auth_mode
                ));
                $internal_account = ilObjUser::_checkExternalAuthAccount($fallback_auth_mode, $this->uid, false);
            }
        }
 
        if (is_string($internal_account) && $internal_account !== '') {
            ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                'Found user "%s" for ext_account "%s" in ILIAS database.',
                $internal_account,
                $this->uid
            ));
 
            if ($this->idp->isSynchronizationEnabled()) {
                ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                    'SAML user synchronisation is enabled, so update existing user "%s" with ext_account "%s".',
                    $internal_account,
                    $this->uid
                ));
                $internal_account = $this->importUser($internal_account, $this->uid, $this->attributes);
            }
 
            if ($update_auth_mode) {
                $usr_id = ilObjUser::_loginExists($internal_account);
                if ($usr_id > 0) {
                    ilObjUser::_writeAuthMode($usr_id, $this->getUserAuthModeName());
                    ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                        'SAML Switched auth_mode of user with login "%s" and ext_account "%s" to "%s".',
                        $internal_account,
                        $this->uid,
                        $this->getUserAuthModeName()
                    ));
                } else {
                    ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                        'SAML Could not switch auth_mode of user with login "%s" and ext_account "%s" to "%s".',
                        $internal_account,
                        $this->uid,
                        $this->getUserAuthModeName()
                    ));
                }
            }
 
            ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                'Authentication succeeded: Found internal login "%s for ext_account "%s" and auth_mode "%s".',
                $internal_account,
                $this->uid,
                $this->getUserAuthModeName()
            ));
 
            $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
            $status->setAuthenticatedUserId(ilObjUser::_lookupId($internal_account));
            ilSession::set('used_external_auth_mode', $this->getTriggerAuthMode());
 
            return true;
        }
 
        ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
            'Could not find an existing user for ext_account "%s" for any relevant auth_mode.',
            $this->uid
        ));
        if ($this->idp->isSynchronizationEnabled()) {
            ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                'SAML user synchronisation is enabled, so determine action for ext_account "%s" and auth_mode "%s".',
                $this->uid,
                $this->getUserAuthModeName()
            ));
            if (!$this->force_new_account && $this->idp->isAccountMigrationEnabled()) {
                ilSession::set(self::SESSION_TMP_ATTRIBUTES, $this->attributes);
                ilSession::set(self::SESSION_TMP_RETURN_TO, $this->return_to);
 
                ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                    'Account migration is enabled, so redirecting ext_account "%s" to account migration screen.',
                    $this->uid
                ));
 
                $this->setExternalAccountName($this->uid);
                $status->setStatus(ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED);
 
                return false;
            }
 
            $new_name = $this->importUser(null, $this->uid, $this->attributes);
            ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
                'Created new user account with login "%s" and ext_account "%s".',
                $new_name,
                $this->uid
            ));
 
            ilSession::set(self::SESSION_TMP_ATTRIBUTES, null);
            ilSession::set(self::SESSION_TMP_RETURN_TO, null);
            ilSession::set('used_external_auth_mode', $this->getTriggerAuthMode());
 
            $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
            $status->setAuthenticatedUserId(ilObjUser::_lookupId($new_name));
 
            return true;
        }
 
        ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug("SAML user synchronisation is not enabled, auth failed.");
        $this->handleAuthenticationFail($status, 'err_auth_saml_no_ilias_user');
 
        return false;
    }
 
    public function migrateAccount(ilAuthStatus $status): void
    {
    }
 
    public function createNewAccount(ilAuthStatus $status): void
    {
        if (
            !is_array(ilSession::get(self::SESSION_TMP_ATTRIBUTES)) ||
            [] === ilSession::get(self::SESSION_TMP_ATTRIBUTES) ||
            $this->getCredentials()->getUsername() === ''
        ) {
            $this->getLogger()->warning('Cannot find user id for external account: ' . $this->getCredentials()->getUsername());
            $this->handleAuthenticationFail($status, self::ERR_WRONG_LOGIN);
            return;
        }
 
        $this->uid = $this->getCredentials()->getUsername();
        $this->attributes = ilSession::get(self::SESSION_TMP_ATTRIBUTES);
        $this->return_to = (string) ilSession::get(self::SESSION_TMP_RETURN_TO);
 
        $this->force_new_account = true;
 
        $this->handleSamlAuth($status);
    }
 
    public function setExternalAccountName(string $a_name): void
    {
        $this->migration_account = $a_name;
    }
 
    public function getExternalAccountName(): string
    {
        return $this->migration_account;
    }
 
    public function getTriggerAuthMode(): string
    {
        return ilAuthUtils::AUTH_SAML . '_' . $this->idp->getIdpId();
    }
 
    public function getUserAuthModeName(): string
    {
        return 'saml_' . $this->idp->getIdpId();
    }
 
    private function importUser(?string $a_internal_login, string $a_external_account, array $a_user_data = []): string
    {
        $mapping = new ilExternalAuthUserAttributeMapping('saml', $this->idp->getIdpId());
 
        $xml_writer = new ilXmlWriter();
        $xml_writer->xmlStartTag('Users');
        if (null === $a_internal_login) {
            $login = $a_user_data[$this->idp->getLoginClaim()][0];
            $login = ilAuthUtils::_generateLogin($login);
 
            $xml_writer->xmlStartTag(
                'User',
                [
                    'Action' => 'Insert',
                    'Language' => $this->lng->getDefaultLanguage()
                ]
            );
            $xml_writer->xmlElement('Login', [], $login);
 
            $xml_writer->xmlElement('Role', [
                'Id' => $this->idp->getDefaultRoleId(),
                'Type' => 'Global',
                'Action' => 'Assign'
            ]);
 
            $xml_writer->xmlElement('Active', [], "true");
            $xml_writer->xmlElement('TimeLimitOwner', [], USER_FOLDER_ID);
            $xml_writer->xmlElement('TimeLimitUnlimited', [], 1);
            $xml_writer->xmlElement('TimeLimitFrom', [], time());
            $xml_writer->xmlElement('TimeLimitUntil', [], time());
            $xml_writer->xmlElement(
                'AuthMode',
                ['type' => $this->getUserAuthModeName()],
                $this->getUserAuthModeName()
            );
            $xml_writer->xmlElement('ExternalAccount', [], $a_external_account);
 
            $mapping = new ilExternalAuthUserCreationAttributeMappingFilter($mapping);
        } else {
            $login = $a_internal_login;
            $usr_id = ilObjUser::_lookupId($a_internal_login);
 
            $xml_writer->xmlStartTag('User', ['Action' => 'Update', 'Id' => $usr_id]);
 
            $loginClaim = $a_user_data[$this->idp->getLoginClaim()][0];
            if (ilStr::strToLower($login) !== ilStr::strToLower($loginClaim)) {
                $login = ilAuthUtils::_generateLogin($loginClaim);
                $xml_writer->xmlElement('Login', [], $login);
            }
 
            $mapping = new ilExternalAuthUserUpdateAttributeMappingFilter($mapping);
        }
 
        foreach ($mapping as $rule) {
            try {
                $attributeValueParser = new ilSamlMappedUserAttributeValueParser($rule, $a_user_data);
                $value = $attributeValueParser->parse();
                $this->buildUserAttributeXml($xml_writer, $rule, $value);
            } catch (ilSamlException $e) {
                $this->getLogger()->warning($e->getMessage());
                continue;
            }
        }
 
        $xml_writer->xmlEndTag('User');
        $xml_writer->xmlEndTag('Users');
 
        ilLoggerFactory::getLogger(self::LOG_COMPONENT)->debug(sprintf(
            'Started import of user "%s" with ext_account "%s" and auth_mode "%s".',
            $login,
            $a_external_account,
            $this->getUserAuthModeName()
        ));
        $importParser = new ilUserImportParser();
        $importParser->setXMLContent($xml_writer->xmlDumpMem(false));
        $importParser->setRoleAssignment([
            $this->idp->getDefaultRoleId() => $this->idp->getDefaultRoleId(),
        ]);
        $importParser->setFolderId(USER_FOLDER_ID);
        $importParser->setUserMappingMode(ilUserImportParser::IL_USER_MAPPING_ID);
        $importParser->startParsing();
 
        return $login;
    }
 
    private function buildUserAttributeXml(
        ilXmlWriter $xml_writer,
        ilExternalAuthUserAttributeMappingRule $rule,
        string $value
    ): void {
        switch (strtolower($rule->getAttribute())) {
            case 'gender':
                $gender_attr = 'Gender';
                match (strtolower($value)) {
                    'n', 'neutral' => $xml_writer->xmlElement($gender_attr, [], 'n'),
                    'm', 'male' => $xml_writer->xmlElement($gender_attr, [], 'm'),
                    // no break
                    default => $xml_writer->xmlElement($gender_attr, [], 'f'),
                };
                break;
 
            case 'firstname':
                $xml_writer->xmlElement('Firstname', [], $value);
                break;
 
            case 'lastname':
                $xml_writer->xmlElement('Lastname', [], $value);
                break;
 
            case 'email':
                $xml_writer->xmlElement('Email', [], $value);
                break;
 
            case 'second_email':
                $xml_writer->xmlElement('SecondEmail', [], $value);
                break;
 
            case 'institution':
                $xml_writer->xmlElement('Institution', [], $value);
                break;
 
            case 'department':
                $xml_writer->xmlElement('Department', [], $value);
                break;
 
            case 'hobby':
                $xml_writer->xmlElement('Hobby', [], $value);
                break;
 
            case 'title':
                $xml_writer->xmlElement('Title', [], $value);
                break;
 
            case 'street':
                $xml_writer->xmlElement('Street', [], $value);
                break;
 
            case 'city':
                $xml_writer->xmlElement('City', [], $value);
                break;
 
            case 'zipcode':
                $xml_writer->xmlElement('PostalCode', [], $value);
                break;
 
            case 'country':
                $xml_writer->xmlElement('Country', [], $value);
                break;
 
            case 'phone_office':
                $xml_writer->xmlElement('PhoneOffice', [], $value);
                break;
 
            case 'phone_home':
                $xml_writer->xmlElement('PhoneHome', [], $value);
                break;
 
            case 'phone_mobile':
                $xml_writer->xmlElement('PhoneMobile', [], $value);
                break;
 
            case 'fax':
                $xml_writer->xmlElement('Fax', [], $value);
                break;
 
            case 'referral_comment':
                $xml_writer->xmlElement('Comment', [], $value);
                break;
 
            case 'matriculation':
                $xml_writer->xmlElement('Matriculation', [], $value);
                break;
 
            case 'birthday':
                $xml_writer->xmlElement('Birthday', [], $value);
                break;
 
            default:
                if (!str_starts_with($rule->getAttribute(), 'udf_')) {
                    break;
                }
 
                $udf_data = explode('_', $rule->getAttribute());
                if (!isset($udf_data[1])) {
                    break;
                }
 
                $this->initUserDefinedFields();
                $field = $this->user_defined_fields[$udf_data[1]] ?? null;
                if ($field === null) {
                    ilLoggerFactory::getLogger('auth')->warning(sprintf(
                        "Invalid/Orphaned UD field mapping detected: %s",
                        $rule->getAttribute()
                    ));
                    break;
                }
 
                $xml_writer->xmlElement(
                    'UserDefinedField',
                    ['Id' => $field->getIdentifier(), 'Name' => $field->getLabel($this->lng)],
                    $value
                );
                break;
        }
    }
 
    private function initUserDefinedFields(): void
    {
        if ($this->user_defined_fields === null) {
            $this->user_defined_fields = $this->profile->getAllUserDefinedFields();
        }
    }
}