Auth_Container_RADIUS Class Reference

Inheritance diagram for Auth_Container_RADIUS:

Collaboration diagram for Auth_Container_RADIUS:

Public Member Functions
	Auth_Container_RADIUS ($options)
	Constructor of the container class. More...
	fetchData ($username, $password, $challenge=null)
	Authenticate. More...
Public Member Functions inherited from Auth_Container
	Auth_Container ()
	Constructor. More...
	fetchData ($username, $password, $isChallengeResponse=false)
	Fetch data from storage container. More...
	verifyPassword ($password1, $password2, $cryptType="md5")
	Crypt and verfiy the entered password. More...
	supportsChallengeResponse ()
	Returns true if the container supports Challenge Response password authentication. More...
	getCryptType ()
	Returns the crypt current crypt type of the container. More...
	listUsers ()
	List all users that are available from the storage container. More...
	getUser ($username)
	Returns a user assoc array. More...
	addUser ($username, $password, $additional=null)
	Add a new user to the storage container. More...
	removeUser ($username)
	Remove user from the storage container. More...
	changePassword ($username, $password)
	Change password for user in the storage container. More...
	log ($message, $level=AUTH_LOG_DEBUG)
	Log a message to the Auth log. More...
Public Member Functions inherited from ilAuthContainerBase
	loginObserver ($a_username, $a_auth)
	Called after successful login. More...
	failedLoginObserver ($a_username, $a_auth)
	Called after failed login. More...
	checkAuthObserver ($a_username, $a_auth)
	Called after check auth requests. More...
	logoutObserver ($a_username, $a_auth)
	Called after logout. More...
	supportsCaptchaVerification ()
	Returns whether or not the auth container supports the verification of captchas This should be true for those auth methods, which are available in the default login form. More...

Data Fields
	$radius
	$authtype
Data Fields inherited from Auth_Container
	$activeUser = ""
	User that is currently selected from the storage container. More...
	$_auth_obj = null
	The Auth object this container is attached to. More...

Detailed Description

Definition at line 48 of file RADIUS.php.

Member Function Documentation

Auth_Container_RADIUS()

Auth_Container_RADIUS::Auth_Container_RADIUS

(

$options

)

Constructor of the container class.

$options can have these keys: 'servers' an array containing an array: servername, port, sharedsecret, timeout, maxtries 'configfile' The filename of the configuration file 'authtype' The type of authentication, one of: PAP, CHAP_MD5, MSCHAPv1, MSCHAPv2, default is PAP

Parameters

$options

associative array

Returns

object Returns an error object if something went wrong

Definition at line 81 of file RADIUS.php.

    {
        $this->authtype = 'PAP';
        if (isset($options['authtype'])) {
            $this->authtype = $options['authtype'];
        }
        $classname = 'Auth_RADIUS_' . $this->authtype;
        if (!class_exists($classname)) {
            PEAR::raiseError("Unknown Authtype, please use one of: "
                    ."PAP, CHAP_MD5, MSCHAPv1, MSCHAPv2!", 41, PEAR_ERROR_DIE);
        }
 
        $this->radius = new $classname;
 
        if (isset($options['configfile'])) {
            $this->radius->setConfigfile($options['configfile']);
        }
 
        $servers = $options['servers'];
        if (is_array($servers)) {
            foreach ($servers as $server) {
                $servername     = $server[0];
                $port           = isset($server[1]) ? $server[1] : 0;
                $sharedsecret   = isset($server[2]) ? $server[2] : 'testing123';
                $timeout        = isset($server[3]) ? $server[3] : 3;
                $maxtries       = isset($server[4]) ? $server[4] : 3;
                $this->radius->addServer($servername, $port, $sharedsecret, $timeout, $maxtries);
            }
        }
 
        if (!$this->radius->start()) {
            PEAR::raiseError($this->radius->getError(), 41, PEAR_ERROR_DIE);
        }
    }

References $authtype, $options, $server, PEAR_ERROR_DIE, and PEAR\raiseError().

Here is the call graph for this function:

fetchData()

Auth_Container_RADIUS::fetchData	(		$username,
			$password,
			$challenge = null
	)

Authenticate.

Parameters

string	Username
string	Password

Returns

bool true on success, false on reject

Reimplemented from Auth_Container.

Definition at line 126 of file RADIUS.php.

    {
        $this->log('Auth_Container_RADIUS::fetchData() called.', AUTH_LOG_DEBUG);
 
        switch($this->authtype) {
            case 'CHAP_MD5':
            case 'MSCHAPv1':
                if (isset($challenge)) {
                    $this->radius->challenge = $challenge;
                    $this->radius->chapid    = 1;
                    $this->radius->response  = pack('H*', $password);
                } else {
                    require_once 'Crypt/CHAP.php';
                    $classname = 'Crypt_' . $this->authtype;
                    $crpt = new $classname;
                    $crpt->password = $password;
                    $this->radius->challenge = $crpt->challenge;
                    $this->radius->chapid    = $crpt->chapid;
                    $this->radius->response  = $crpt->challengeResponse();
                }
                break;
 
            case 'MSCHAPv2':
                require_once 'Crypt/CHAP.php';
                $crpt = new Crypt_MSCHAPv2;
                $crpt->username = $username;
                $crpt->password = $password;
                $this->radius->challenge     = $crpt->authChallenge;
                $this->radius->peerChallenge = $crpt->peerChallenge;
                $this->radius->chapid        = $crpt->chapid;
                $this->radius->response      = $crpt->challengeResponse();
                break;
 
            default:
                $this->radius->password = $password;
                break;
        }
 
        $this->radius->username = $username;
 
        $this->radius->putAuthAttributes();
        $result = $this->radius->send();
        if (PEAR::isError($result)) {
            return false;
        }
 
        $this->radius->getAttributes();
//      just for debugging
//      $this->radius->dumpAttributes();
 
        return $result;
    }

References $authtype, $result, AUTH_LOG_DEBUG, PEAR\isError(), and Auth_Container\log().

Here is the call graph for this function:

Field Documentation

$authtype

Auth_Container_RADIUS::$authtype

Definition at line 63 of file RADIUS.php.

Referenced by Auth_Container_RADIUS(), and fetchData().

$radius

Auth_Container_RADIUS::$radius

Definition at line 57 of file RADIUS.php.

---

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

• Services/PEAR/lib/Auth/Container/RADIUS.php