Collaboration diagram for ilWebDAVAuthentication:

Public Member Functions
	isUserAgentSessionAware (string $user_agent)

	authenticate ($a_username, $a_password)
	Callback function. More...

Protected Member Functions
	getUserAgent ()
	Gets the given user agent from the request. More...

Protected Attributes
	$session_aware_webdav_clients

Detailed Description

Class ilWebDAVAuthentication.

Implements the callback to authenticate users. Is called by the sabreDAV Authentication Plugin

Author: Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch $Id$

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

Member Function Documentation

◆ authenticate()

ilWebDAVAuthentication::authenticate	(	$a_username,
		$a_password
	)

Callback function.

Identifies user by username and password and returns if authentication was successful

Parameters

$a_username
$a_password

Returns: bool

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

References $DIC, ilAuthFrontendFactory\CONTEXT_HTTP, ilSession\enableWebAccessWithoutSession(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), getUserAgent(), isUserAgentSessionAware(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

     {
         global $DIC;
 
         if ($this->isUserAgentSessionAware($this->getUserAgent())) {
             if ($DIC['ilAuthSession']->isAuthenticated() && $DIC->user()->getId() != 0) {
                 ilLoggerFactory::getLogger('webdav')->debug('User authenticated through session. UserID = ' . $DIC->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(
             $DIC['ilAuthSession'],
             $status,
             $credentials,
             $providers
             );
 
         $frontend->authenticate();
         
         switch ($status->getStatus()) {
             case ilAuthStatus::STATUS_AUTHENTICATED:
                 ilLoggerFactory::getLogger('webdav')->debug('User authenticated through basic authentication. UserId = ' . $DIC->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;
     }

Here is the call graph for this function:

◆ getUserAgent()

ilWebDAVAuthentication::getUserAgent ( )

protected

Gets the given user agent from the request.

If user agent is not set -> return an empty string

Returns: string

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

References $_SERVER.

Referenced by authenticate().

                                       : string
     {
         // is user agent set?
         $user_agent = isset($_SERVER["HTTP_USER_AGENT"]) ? $_SERVER["HTTP_USER_AGENT"] : "";
 
         // is value of user agent a string?
         $user_agent = is_string($user_agent) ? $user_agent : "";
 
         return $user_agent;
     }

Here is the caller graph for this function:

◆ isUserAgentSessionAware()

ilWebDAVAuthentication::isUserAgentSessionAware ( string $user_agent )

Parameters

string $user_agent User Agent from $_SERVER["HTTP_USER_AGENT"]

Returns: bool

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

Referenced by authenticate().

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

Here is the caller graph for this function:

Field Documentation

◆ $session_aware_webdav_clients

ilWebDAVAuthentication::$session_aware_webdav_clients

protected

Initial value:

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

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

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

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

Public Member Functions

Protected Member Functions