ilAuthProviderRadius Class Reference

Description of class class. More...

Inheritance diagram for ilAuthProviderRadius:

Collaboration diagram for ilAuthProviderRadius:

Public Member Functions
	__construct (\ilAuthCredentials $credentials)
	createNewAccount (\ilAuthStatus $status)
	create new account More...
	doAuthentication (\ilAuthStatus $status)
	do authentication More...
	getExternalAccountName ()
	get external account name More...
	getTriggerAuthMode ()
	get trigger auth mode More...
	getUserAuthModeName ()
	get user auth mode name More...
	migrateAccount (ilAuthStatus $status)
	Migrate existing account to radius authentication Create new account. Parameters ilAuthStatus . More...
Public Member Functions inherited from ilAuthProvider
	__construct (ilAuthCredentials $credentials)
	Constructor. More...
	getLogger ()
	Get logger. More...
	getCredentials ()
Public Member Functions inherited from ilAuthProviderAccountMigrationInterface
	createNewAccount (ilAuthStatus $status)
	Create new ILIAS account for external_account. More...

Data Fields
const	CONNECT_TIMEOUT = 3
const	RETRIES = 1
Data Fields inherited from ilAuthProvider
const	STATUS_UNDEFINED = 0
const	STATUS_AUTHENTICATION_SUCCESS = 1
const	STATUS_AUTHENTICATION_FAILED = 2
const	STATUS_MIGRATION = 3

Private Attributes
	$settings = null
	$external_account = ''

Additional Inherited Members
Protected Member Functions inherited from ilAuthProvider
	handleAuthenticationFail (ilAuthStatus $status, $a_reason)
	Handle failed authentication. More...

Detailed Description

Description of class class.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 15 of file class.ilAuthProviderRadius.php.

Constructor & Destructor Documentation

__construct()

ilAuthProviderRadius::__construct

(

\ilAuthCredentials

$credentials

)

Definition at line 28 of file class.ilAuthProviderRadius.php.

References ilRadiusSettings\_getInstance(), and settings().

    {
        parent::__construct($credentials);
        
        include_once './Services/Radius/classes/class.ilRadiusSettings.php';
        $this->settings = ilRadiusSettings::_getInstance();
    }

Here is the call graph for this function:

Member Function Documentation

createNewAccount()

ilAuthProviderRadius::createNewAccount

(

\ilAuthStatus

$status

)

create new account

Parameters

\ilAuthStatus

$status

Definition at line 41 of file class.ilAuthProviderRadius.php.

    {
    }

doAuthentication()

ilAuthProviderRadius::doAuthentication

(

\ilAuthStatus

$status

)

do authentication

Parameters

\ilAuthStatus

$status

Implements ilAuthProviderInterface.

Definition at line 49 of file class.ilAuthProviderRadius.php.

References $result, $server, ilObjUser\_checkExternalAuthAccount(), ilObjUser\_lookupId(), ilAuthProvider\getCredentials(), ilAuthProvider\getLogger(), ilAuthProvider\handleAuthenticationFail(), ilAuthStatus\setAuthenticatedUserId(), ilAuthStatus\setStatus(), settings(), and ilAuthStatus\STATUS_AUTHENTICATED.

    {
        $radius = radius_auth_open();
        
        foreach ($this->settings->getServers() as $server) {
            $this->getLogger()->debug('Using: ' . $server . ':' . $this->settings->getPort());
            radius_add_server(
                $radius,
                trim($server),
                $this->settings->getPort(),
                $this->settings->getSecret(),
                self::CONNECT_TIMEOUT,
                self::RETRIES
            );
        }
        
        radius_create_request($radius, RADIUS_ACCESS_REQUEST);
        radius_put_attr($radius, RADIUS_USER_NAME, $this->getCredentials()->getUsername());
        radius_put_attr($radius, RADIUS_USER_PASSWORD, $this->getCredentials()->getPassword());

        $this->getLogger()->debug('username: ' . $this->getCredentials()->getUsername());

        $result = radius_send_request($radius);
        
        switch ($result) {
            case RADIUS_ACCESS_ACCEPT:
                $this->getLogger()->info('Radius authentication successful.');
                $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
                
                $local_login = ilObjUser::_checkExternalAuthAccount('radius', $this->getCredentials()->getUsername());
                $status->setAuthenticatedUserId(ilObjUser::_lookupId($local_login));
                return true;
                
            case RADIUS_ACCESS_REJECT:
                $this->getLogger()->info('Radius authentication rejected with message: ' . radius_strerror($radius));
                $this->handleAuthenticationFail($status, 'err_wrong_login');
                return false;
                
            case RADIUS_ACCESS_CHALLENGE:
                $this->getLogger()->info('Radius authentication failed (access challenge): ' . radius_strerror($radius));
                $this->handleAuthenticationFail($status, 'err_wrong_login');
                return false;
                
            default:
                $this->getLogger()->error('Radius authentication failed with message: ' . radius_strerror($radius));
                $this->handleAuthenticationFail($status, 'err_wrong_login');
                return false;
        }
    }

Here is the call graph for this function:

getExternalAccountName()

ilAuthProviderRadius::getExternalAccountName

(

)

get external account name

Returns

string Get external account for accoun migration

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 103 of file class.ilAuthProviderRadius.php.

References $external_account.

    {
        return $this->external_account;
    }

getTriggerAuthMode()

ilAuthProviderRadius::getTriggerAuthMode

(

)

get trigger auth mode

Returns

string

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 112 of file class.ilAuthProviderRadius.php.

References AUTH_RADIUS.

    {
        return AUTH_RADIUS;
    }

getUserAuthModeName()

ilAuthProviderRadius::getUserAuthModeName

(

)

get user auth mode name

Returns

string

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 121 of file class.ilAuthProviderRadius.php.

    {
        return 'radius';
    }

migrateAccount()

ilAuthProviderRadius::migrateAccount

(

ilAuthStatus

$status

)

Migrate existing account to radius authentication Create new account.

Parameters

ilAuthStatus

.

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 130 of file class.ilAuthProviderRadius.php.

    {
    }

Field Documentation

$external_account

ilAuthProviderRadius::$external_account = ''

private

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

Referenced by getExternalAccountName().

$settings

ilAuthProviderRadius::$settings = null

private

Definition at line 23 of file class.ilAuthProviderRadius.php.

CONNECT_TIMEOUT

const ilAuthProviderRadius::CONNECT_TIMEOUT = 3

Definition at line 17 of file class.ilAuthProviderRadius.php.

RETRIES

const ilAuthProviderRadius::RETRIES = 1

Definition at line 18 of file class.ilAuthProviderRadius.php.

---

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

• Services/Radius/classes/class.ilAuthProviderRadius.php