ilWebDAVAuthentication Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilWebDAVAuthentication:

Public Member Functions
	__construct (ilObjUser $user, ilAuthSession $session)
	authenticate (string $a_username, string $a_password)

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

Protected Attributes
array	$session_aware_webdav_clients
ilObjUser	$user
ilAuthSession	$session

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

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

Definition at line 24 of file class.ilWebDAVAuthentication.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVAuthentication::__construct	(	ilObjUser	$user,
		ilAuthSession	$session
	)

Definition at line 46 of file class.ilWebDAVAuthentication.php.

    {
        $this->user = $user;
        $this->session = $session;
    }

References $session, $user, and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

authenticate()

ilWebDAVAuthentication::authenticate	(	string	$a_username,
		string	$a_password
	)

Definition at line 70 of file class.ilWebDAVAuthentication.php.

                                                                        : bool
    {
        if ($this->isUserAgentSessionAware($this->getUserAgent())) {
            if ($this->session->isAuthenticated() && $this->user->getId() != 0) {
                ilLoggerFactory::getLogger('webdav')->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:
                ilLoggerFactory::getLogger('webdav')->debug('User authenticated through basic authentication. UserId = ' . $this->user->getId());
                return true;
 
            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                ilLoggerFactory::getLogger('webdav')->info('Basic authentication failed; Account migration required.');
                return false;
 
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                ilLoggerFactory::getLogger('webdav')->info('Basic authentication failed; Wrong login, password.');
                return false;
        }
 
        return false;
    }

References ilAuthFrontendFactory\CONTEXT_HTTP, ilSession\enableWebAccessWithoutSession(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), getUserAgent(), isUserAgentSessionAware(), 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()

ilWebDAVAuthentication::getUserAgent ( )

protected

Definition at line 62 of file class.ilWebDAVAuthentication.php.

                                     : string
    {
        $user_agent = $_SERVER["HTTP_USER_AGENT"] ?? "";
        $user_agent = is_string($user_agent) ? $user_agent : "";
 
        return $user_agent;
    }

References $_SERVER.

Referenced by authenticate().

Here is the caller graph for this function:

isUserAgentSessionAware()

ilWebDAVAuthentication::isUserAgentSessionAware ( string  $user_agent )

protected

Definition at line 52 of file class.ilWebDAVAuthentication.php.

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

Referenced by authenticate().

Here is the caller graph for this function:

Field Documentation

$session

ilAuthSession ilWebDAVAuthentication::$session

protected

Definition at line 44 of file class.ilWebDAVAuthentication.php.

Referenced by __construct().

$session_aware_webdav_clients

array ilWebDAVAuthentication::$session_aware_webdav_clients

protected

Initial value:

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

Definition at line 38 of file class.ilWebDAVAuthentication.php.

$user

ilObjUser ilWebDAVAuthentication::$user

protected

Definition at line 43 of file class.ilWebDAVAuthentication.php.

Referenced by __construct().

---

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

• Services/WebDAV/classes/auth/class.ilWebDAVAuthentication.php