ILIAS\WebDAV\Auth\ILIASAuthenticationCallback Class Reference

Collaboration diagram for ILIAS\WebDAV\Auth\ILIASAuthenticationCallback:

Public Member Functions
	__construct (protected ilObjUser $user, protected ilAuthSession $session, protected ilLogger $logger, Filesystem $filesystem, SecretKeyRotation $secret_key_rotation)
	authenticate (string $a_username, string $a_password)

Protected Member Functions
	isUserAgentSessionAware (string $user_agent)
	getUserAgent ()

Protected Attributes
array	$session_aware_webdav_clients

Private Attributes
ILIASAuthenticationFileCache	$file_cache

Detailed Description

Author

Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch

Definition at line 37 of file ILIASAuthenticationCallback.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WebDAV\Auth\ILIASAuthenticationCallback::__construct	(	protected ilObjUser	$user,
		protected ilAuthSession	$session,
		protected ilLogger	$logger,
		Filesystem	$filesystem,
		SecretKeyRotation	$secret_key_rotation
	)

Definition at line 57 of file ILIASAuthenticationCallback.php.

      {
        $this->file_cache = new ILIASAuthenticationFileCache(
            $filesystem,
            $secret_key_rotation
        );
    }

Member Function Documentation

authenticate()

ILIAS\WebDAV\Auth\ILIASAuthenticationCallback::authenticate	(	string	$a_username,
		string	$a_password
	)

Definition at line 80 of file ILIASAuthenticationCallback.php.

                                                                        : bool
    {
        global $DIC;
 
        $cached = $this->file_cache->isAuthenticated($a_username, $a_password);
        if ($cached !== null) {
            $this->logger->info('WEBDAV: User authenticated through cache. UserID = ' . $cached);
            $DIC->user()->setId($cached);
            ilSession::enableWebAccessWithoutSession(true);
            return true;
        }
        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()
                );
 
                $this->file_cache->setAuthenticated($a_username, $a_password, (int) $DIC->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;
    }

References $DIC, ANONYMOUS_USER_ID, ilAuthFrontendFactory\CONTEXT_HTTP, ilSession\enableWebAccessWithoutSession(), ilAuthStatus\getInstance(), ILIAS\WebDAV\Auth\ILIASAuthenticationCallback\getUserAgent(), ILIAS\WebDAV\Auth\ILIASAuthenticationCallback\isUserAgentSessionAware(), ILIAS\Repository\logger(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, ilAuthStatus\STATUS_AUTHENTICATION_FAILED, and ILIAS\Repository\user().

Here is the call graph for this function:

getUserAgent()

ILIAS\WebDAV\Auth\ILIASAuthenticationCallback::getUserAgent ( )

protected

Definition at line 75 of file ILIASAuthenticationCallback.php.

                                     : string
    {
        return $_SERVER["HTTP_USER_AGENT"] ?? '';
    }

References $_SERVER.

Referenced by ILIAS\WebDAV\Auth\ILIASAuthenticationCallback\authenticate().

Here is the caller graph for this function:

isUserAgentSessionAware()

ILIAS\WebDAV\Auth\ILIASAuthenticationCallback::isUserAgentSessionAware ( string  $user_agent )

protected

Definition at line 70 of file ILIASAuthenticationCallback.php.

                                                                  : bool
    {
        return array_any($this->session_aware_webdav_clients, fn($webdav_client_name): string|false => stristr($user_agent, (string) $webdav_client_name));
    }

Referenced by ILIAS\WebDAV\Auth\ILIASAuthenticationCallback\authenticate().

Here is the caller graph for this function:

Field Documentation

$file_cache

ILIASAuthenticationFileCache ILIAS\WebDAV\Auth\ILIASAuthenticationCallback::$file_cache

private

Definition at line 39 of file ILIASAuthenticationCallback.php.

$session_aware_webdav_clients

array ILIAS\WebDAV\Auth\ILIASAuthenticationCallback::$session_aware_webdav_clients

protected

Initial value:

= [
        "Microsoft-WebDAV-MiniRedir",
        "gvfs"
    ]

Definition at line 52 of file ILIASAuthenticationCallback.php.

---

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

• components/ILIAS/WebDAV/src/Auth/ILIASAuthenticationCallback.php