Inheritance diagram for sspmod_radius_Auth_Source_Radius:

Collaboration diagram for sspmod_radius_Auth_Source_Radius:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...

Public Member Functions inherited from sspmod_core_Auth_UserPassBase
	__construct ($info, &$config)
	Constructor for this authentication source. More...

	setForcedUsername ($forcedUsername)
	Set forced username. More...

	getLoginLinks ()
	Return login links from configuration. More...

	getRememberUsernameEnabled ()
	Getter for the authsource config option remember.username.enabled. More...

	getRememberUsernameChecked ()
	Getter for the authsource config option remember.username.checked. More...

	isRememberMeEnabled ()
	Check if the "remember me" feature is enabled. More...

	isRememberMeChecked ()
	Check if the "remember me" checkbox should be checked. More...

	authenticate (&$state)
	Initialize login. More...

Public Member Functions inherited from SimpleSAML_Auth_Source
	__construct ($info, &$config)
	Constructor for an authentication source. More...

	getAuthId ()
	Retrieve the ID of this authentication source. More...

	authenticate (&$state)
	Process a request. More...

	reauthenticate (array &$state)
	Reauthenticate an user. More...

	initLogin ($return, $errorURL=null, array $params=array())
	Start authentication. More...

	logout (&$state)
	Log out from this authentication source. More...

Protected Member Functions
	login ($username, $password)
	Attempt to log in using the given username and password. More...

Protected Member Functions inherited from sspmod_core_Auth_UserPassBase
	login ($username, $password)
	Attempt to log in using the given username and password. More...

Protected Member Functions inherited from SimpleSAML_Auth_Source
	addLogoutCallback ($assoc, $state)
	Add a logout callback association. More...

	callLogoutCallback ($assoc)
	Call a logout callback based on association. More...

Private Attributes
	$servers
	The list of radius servers to use. More...

	$hostname
	The hostname of the radius server. More...

	$port
	The port of the radius server. More...

	$secret
	The secret used when communicating with the radius server. More...

	$timeout
	The timeout for contacting the radius server. More...

	$retries
	The number of retries which should be attempted. More...

	$realm
	The realm to be added to the entered username. More...

	$usernameAttribute
	The attribute name where the username should be stored. More...

	$vendor
	The vendor for the RADIUS attributes we are interrested in. More...

	$vendorType
	The vendor-specific attribute for the RADIUS attributes we are interrested in. More...

	$nasIdentifier
	The NAS-Identifier that should be set in Access-Request packets. More...

Additional Inherited Members
Static Public Member Functions inherited from sspmod_core_Auth_UserPassBase
static	handleLogin ($authStateId, $username, $password)
	Handle login request. More...

Static Public Member Functions inherited from SimpleSAML_Auth_Source
static	getSourcesOfType ($type)
	Get sources of a specific type. More...

static	completeAuth (&$state)
	Complete authentication. More...

static	loginCompleted ($state)
	Called when a login operation has finished. More...

static	completeLogout (&$state)
	Complete logout. More...

static	getById ($authId, $type=null)
	Retrieve authentication source. More...

static	logoutCallback ($state)
	Called when the authentication source receives an external logout request. More...

static	getSources ()
	Retrieve list of authentication sources. More...

Data Fields inherited from sspmod_core_Auth_UserPassBase
const	STAGEID = 'sspmod_core_Auth_UserPassBase.state'
	The string used to identify our states. More...

const	AUTHID = 'sspmod_core_Auth_UserPassBase.AuthId'
	The key of the AuthId field in the state. More...

Static Protected Member Functions inherited from SimpleSAML_Auth_Source
static	validateSource ($source, $id)
	Make sure that the first element of an auth source is its identifier. More...

Protected Attributes inherited from sspmod_core_Auth_UserPassBase
	$loginLinks
	Links to pages from login page. More...

	$rememberUsernameEnabled = FALSE

	$rememberUsernameChecked = FALSE

	$rememberMeEnabled = FALSE

	$rememberMeChecked = FALSE

Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Detailed Description

Definition at line 10 of file Radius.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_radius_Auth_Source_Radius::__construct	(	$info,
		$config
	)

Constructor for this authentication source.

Parameters

array	$info	Information about this authentication source.
array	$config	Configuration.

Definition at line 74 of file Radius.php.

References $config, $info, array, and SimpleSAML_Configuration\loadFromArray().

     {
         assert('is_array($info)');
         assert('is_array($config)');
 
         // Call the parent constructor first, as required by the interface
         parent::__construct($info, $config);
 
         // Parse configuration.
         $config = SimpleSAML_Configuration::loadFromArray($config,
             'Authentication source ' . var_export($this->authId, true));
 
         $this->servers = $config->getArray('servers', array());
         /* For backwards compatibility. */
         if (empty($this->servers)) {
             $this->hostname = $config->getString('hostname');
             $this->port = $config->getIntegerRange('port', 1, 65535, 1812);
             $this->secret = $config->getString('secret');
             $this->servers[] = array('hostname' => $this->hostname,
                                      'port' => $this->port,
                                      'secret' => $this->secret);
         }
         $this->timeout = $config->getInteger('timeout', 5);
         $this->retries = $config->getInteger('retries', 3);
         $this->realm = $config->getString('realm', null);
         $this->usernameAttribute = $config->getString('username_attribute', null);
         $this->nasIdentifier = $config->getString('nas_identifier',
             \SimpleSAML\Utils\HTTP::getSelfHost());
 
         $this->vendor = $config->getInteger('attribute_vendor', null);
         if ($this->vendor !== null) {
             $this->vendorType = $config->getInteger('attribute_vendor_type');
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ login()

sspmod_radius_Auth_Source_Radius::login	(	$username,
		$password
	)

protected

Attempt to log in using the given username and password.

Parameters

string	$username	The username the user wrote.
string	$password	The password the user wrote.

Returns: array Associative array with the user's attributes.

Definition at line 117 of file Radius.php.

References $attributes, $password, $res, $server, $success, $usernameAttribute, $vendor, array, and SimpleSAML\Logger\info().

     {
         assert('is_string($username)');
         assert('is_string($password)');
 
         $radius = radius_auth_open();
 
         /* Try to add all radius servers, trigger a failure if no one works. */
         $success = false;
         foreach ($this->servers as $server) {
             if (!isset($server['port'])) {
                 $server['port'] = 1812;
             }
             if (!radius_add_server($radius,
                 $server['hostname'], $server['port'], $server['secret'], 
                 $this->timeout, $this->retries)) {
                 SimpleSAML\Logger::info("Could not add radius server: " .
                     radius_strerror($radius));
                 continue;
             }
             $success = true;
         }
         if (!$success) {
             throw new Exception('Error adding radius servers, no servers available');
         }
 
         if (!radius_create_request($radius, RADIUS_ACCESS_REQUEST)) {
             throw new Exception('Error creating radius request: ' .
                 radius_strerror($radius));
         }
 
         if ($this->realm === null) {
             radius_put_attr($radius, RADIUS_USER_NAME, $username);
         } else {
             radius_put_attr($radius, RADIUS_USER_NAME, $username . '@' . $this->realm);
         }
         radius_put_attr($radius, RADIUS_USER_PASSWORD, $password);
 
         if ($this->nasIdentifier !== null) {
             radius_put_attr($radius, RADIUS_NAS_IDENTIFIER, $this->nasIdentifier);
         }
 
         $res = radius_send_request($radius);
         if ($res != RADIUS_ACCESS_ACCEPT) {
             switch ($res) {
             case RADIUS_ACCESS_REJECT:
                 /* Invalid username or password. */
                 throw new SimpleSAML_Error_Error('WRONGUSERPASS');
             case RADIUS_ACCESS_CHALLENGE:
                 throw new Exception('Radius authentication error: Challenge requested, but not supported.');
             default:
                 throw new Exception('Error during radius authentication: ' .
                     radius_strerror($radius));
             }
         }
 
         /* If we get this far, we have a valid login. */
 
         $attributes = array();
 
         if ($this->usernameAttribute !== null) {
             $attributes[$this->usernameAttribute] = array($username);
         }
 
         if ($this->vendor === null) {
             /*
              * We aren't interested in any vendor-specific attributes. We are
              * therefore done now.
              */
             return $attributes;
         }
 
         /* get AAI attribute sets. Contributed by Stefan Winter, (c) RESTENA */
         while ($resa = radius_get_attr($radius)) {
 
             if (!is_array($resa)) {
                 throw new Exception('Error getting radius attributes: ' .
                     radius_strerror($radius));
             }
 
             /* Use the received user name */
             if ($resa['attr'] == RADIUS_USER_NAME) {
                 $attributes[$this->usernameAttribute] = array($resa['data']);
                 continue;
             }
 
             if ($resa['attr'] !== RADIUS_VENDOR_SPECIFIC) {
                 continue;
             }
 
             $resv = radius_get_vendor_attr($resa['data']);
             if (!is_array($resv)) {
                 throw new Exception('Error getting vendor specific attribute: ' .
                     radius_strerror($radius));
             }
 
             $vendor = $resv['vendor'];
             $attrv = $resv['attr'];
             $datav = $resv['data'];
 
             if ($vendor != $this->vendor || $attrv != $this->vendorType) {
                 continue;
             }
 
             $attrib_name = strtok($datav,'=');
             $attrib_value = strtok('=');
 
             /* if the attribute name is already in result set,
                 add another value */
             if (array_key_exists($attrib_name, $attributes)) {
                 $attributes[$attrib_name][] = $attrib_value;
             } else {
                 $attributes[$attrib_name] = array($attrib_value);
             }
         }
         /* end of contribution */
 
         return $attributes;
     }

Here is the call graph for this function:

Field Documentation

◆ $hostname

sspmod_radius_Auth_Source_Radius::$hostname

private

The hostname of the radius server.

Definition at line 20 of file Radius.php.

◆ $nasIdentifier

sspmod_radius_Auth_Source_Radius::$nasIdentifier

private

The NAS-Identifier that should be set in Access-Request packets.

Definition at line 66 of file Radius.php.

◆ $port

sspmod_radius_Auth_Source_Radius::$port

private

The port of the radius server.

Definition at line 25 of file Radius.php.

◆ $realm

sspmod_radius_Auth_Source_Radius::$realm

private

The realm to be added to the entered username.

Definition at line 45 of file Radius.php.

◆ $retries

sspmod_radius_Auth_Source_Radius::$retries

private

The number of retries which should be attempted.

Definition at line 40 of file Radius.php.

◆ $secret

sspmod_radius_Auth_Source_Radius::$secret

private

The secret used when communicating with the radius server.

Definition at line 30 of file Radius.php.

◆ $servers

sspmod_radius_Auth_Source_Radius::$servers

private

The list of radius servers to use.

Definition at line 15 of file Radius.php.

◆ $timeout

sspmod_radius_Auth_Source_Radius::$timeout

private

The timeout for contacting the radius server.

Definition at line 35 of file Radius.php.

◆ $usernameAttribute

sspmod_radius_Auth_Source_Radius::$usernameAttribute

private

The attribute name where the username should be stored.

Definition at line 50 of file Radius.php.

Referenced by login().

◆ $vendor

sspmod_radius_Auth_Source_Radius::$vendor

private

The vendor for the RADIUS attributes we are interrested in.

Definition at line 55 of file Radius.php.

Referenced by login().

◆ $vendorType

sspmod_radius_Auth_Source_Radius::$vendorType

private

The vendor-specific attribute for the RADIUS attributes we are interrested in.

Definition at line 61 of file Radius.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/radius/lib/Auth/Source/Radius.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ login()

Field Documentation

◆ $hostname

◆ $nasIdentifier

◆ $port

◆ $realm

◆ $retries

◆ $secret

◆ $servers

◆ $timeout

◆ $usernameAttribute

◆ $vendor

◆ $vendorType