class.ilWebDAVAuthentication.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilWebDAVAuthentication
{
    protected array $session_aware_webdav_clients = [
        "Microsoft-WebDAV-MiniRedir",
        "gvfs"
    ];

    public function __construct(
        protected ilObjUser $user,
        protected ilAuthSession $session,
        protected ilLogger $logger
    ) {
    }

    protected function isUserAgentSessionAware(string $user_agent): bool
    {
        foreach ($this->session_aware_webdav_clients as $webdav_client_name) {
            if (stristr($user_agent, $webdav_client_name)) {
                return true;
            }
        }
        return false;
    }

    protected function getUserAgent(): string
    {
        $user_agent = $_SERVER["HTTP_USER_AGENT"] ?? "";
        $user_agent = is_string($user_agent) ? $user_agent : "";

        return $user_agent;
    }

    public function authenticate(string $a_username, string $a_password): bool
    {
        if ($this->isUserAgentSessionAware($this->getUserAgent())) {
            if ($this->session->isAuthenticated()
                && $this->user->getId() !== 0
                && $this->user->getId() !== ANONYMOUS_USER_ID) {
                $this->logger->debug('User authenticated through session. UserID = ' . $this->user->getId());
                return true;
            }
        } else {
            ilSession::enableWebAccessWithoutSession(true);
        }

        $credentials = new ilAuthFrontendCredentialsHTTP();
        $credentials->setUsername($a_username);
        $credentials->setPassword($a_password);

        $provider_factory = new ilAuthProviderFactory();
        $providers = $provider_factory->getProviders($credentials);

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_HTTP);
        $frontend = $frontend_factory->getFrontend(
            $this->session,
            $status,
            $credentials,
            $providers
        );

        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->logger->debug(
                    'User authenticated through basic authentication. UserId = ' . $this->user->getId()
                );
                return true;

            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                $this->logger->info('Basic authentication failed; Account migration required.');
                return false;

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->logger->info('Basic authentication failed; Wrong login, password.');
                return false;
        }

        return false;
    }
}