ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
All Data Structures Namespaces Files Functions Variables Modules Pages
Auth_RADIUS_PAP Class Reference
+ Inheritance diagram for Auth_RADIUS_PAP:
+ Collaboration diagram for Auth_RADIUS_PAP:

Public Member Functions

 Auth_RADIUS_PAP ($username=null, $password=null)
 Constructor. More...
 
 open ()
 Creates a RADIUS resource. More...
 
 createRequest ()
 Creates an authentication request. More...
 
 putAuthAttributes ()
 Put authentication specific attributes. More...
 
- Public Member Functions inherited from Auth_RADIUS
 Auth_RADIUS ()
 Constructor. More...
 
 addServer ($servername='localhost', $port=0, $sharedSecret='testing123', $timeout=3, $maxtries=3)
 Adds a RADIUS server to the list of servers for requests. More...
 
 getError ()
 Returns an error message, if an error occurred. More...
 
 setConfigfile ($file)
 Sets the configuration-file. More...
 
 putAttribute ($attrib, $value, $type=null)
 Puts an attribute. More...
 
 putVendorAttribute ($vendor, $attrib, $value, $type=null)
 Puts a vendor-specific attribute. More...
 
 dumpAttributes ()
 Prints known attributes received from the server. More...
 
 open ()
 Overwrite this. More...
 
 createRequest ()
 Overwrite this. More...
 
 putStandardAttributes ()
 Puts standard attributes. More...
 
 putAuthAttributes ()
 Puts custom attributes. More...
 
 putServer ($servername, $port=0, $sharedsecret='testing123', $timeout=3, $maxtries=3)
 Configures the radius library. More...
 
 putConfigfile ($file)
 Configures the radius library via external configurationfile. More...
 
 start ()
 Initiates a RADIUS request. More...
 
 send ()
 Sends a prepared RADIUS request and waits for a response. More...
 
 getAttributes ()
 Reads all received attributes after sending the request. More...
 
 close ()
 Frees resources. More...
 
- Public Member Functions inherited from PEAR
 PEAR ($error_class=null)
 Constructor. More...
 
 _PEAR ()
 Destructor (the emulated type of...). More...
 
getStaticProperty ($class, $var)
 If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...
 
 registerShutdownFunc ($func, $args=array())
 Use this function to register a shutdown method for static classes. More...
 
 isError ($data, $code=null)
 Tell whether a value is a PEAR error. More...
 
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled. More...
 
 expectError ($code=' *')
 This method is used to tell which errors you expect to get. More...
 
 popExpect ()
 This method pops one element off the expected error codes stack. More...
 
 _checkDelExpect ($error_code)
 This method checks unsets an error code if available. More...
 
 delExpect ($error_code)
 This method deletes all occurences of the specified element from the expected error codes stack. More...
 
raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
 This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...
 
throwError ($message=null, $code=null, $userinfo=null)
 Simpler form of raiseError with fewer options. More...
 
 staticPushErrorHandling ($mode, $options=null)
 
 staticPopErrorHandling ()
 
 pushErrorHandling ($mode, $options=null)
 Push a new error handler on top of the error handler options stack. More...
 
 popErrorHandling ()
 Pop the last error handler used. More...
 
 loadExtension ($ext)
 OS independant PHP extension load. More...
 

Additional Inherited Members

- Data Fields inherited from Auth_RADIUS
 $_servers = array()
 
 $_configfile = null
 
 $res = null
 
 $username = null
 
 $password = null
 
 $attributes = array()
 
 $rawAttributes = array()
 
 $rawVendorAttributes = array()
 
 $useStandardAttributes = true
 
- Data Fields inherited from PEAR
 $_debug = false
 
 $_default_error_mode = null
 
 $_default_error_options = null
 
 $_default_error_handler = ''
 
 $_error_class = 'PEAR_Error'
 
 $_expected_errors = array()
 

Detailed Description

Definition at line 568 of file RADIUS.php.

Member Function Documentation

◆ Auth_RADIUS_PAP()

Auth_RADIUS_PAP::Auth_RADIUS_PAP (   $username = null,
  $password = null 
)

Constructor.

Parameters
string$usernameUsername
string$passwordPassword
Returns
void

Definition at line 578 of file RADIUS.php.

References Auth_RADIUS\$password, Auth_RADIUS\$username, and Auth_RADIUS\Auth_RADIUS().

579  {
580  $this->Auth_RADIUS();
581  $this->username = $username;
582  $this->password = $password;
583  }
Auth_RADIUS()
Constructor.
Definition: RADIUS.php:128
+ Here is the call graph for this function:

◆ createRequest()

Auth_RADIUS_PAP::createRequest ( )

Creates an authentication request.

Creates an authentication request. You MUST call this method before you can put any attribute

Returns
bool true on success, false on error

Definition at line 610 of file RADIUS.php.

611  {
612  if (!radius_create_request($this->res, RADIUS_ACCESS_REQUEST)) {
613  return false;
614  }
615  return true;
616  }

◆ open()

Auth_RADIUS_PAP::open ( )

Creates a RADIUS resource.

Creates a RADIUS resource for authentication. This should be the first call before you make any other things with the library.

Returns
bool true on success, false on error

Definition at line 593 of file RADIUS.php.

594  {
595  $this->res = radius_auth_open();
596  if (!$this->res) {
597  return false;
598  }
599  return true;
600  }

◆ putAuthAttributes()

Auth_RADIUS_PAP::putAuthAttributes ( )

Put authentication specific attributes.

Returns
void

Definition at line 623 of file RADIUS.php.

References Auth_RADIUS\putAttribute().

624  {
625  if (isset($this->username)) {
626  $this->putAttribute(RADIUS_USER_NAME, $this->username);
627  }
628  if (isset($this->password)) {
629  $this->putAttribute(RADIUS_USER_PASSWORD, $this->password);
630  }
631  }
putAttribute($attrib, $value, $type=null)
Puts an attribute.
Definition: RADIUS.php:185
+ Here is the call graph for this function:

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