PHP Class Horde_Auth_Ipbasic, horde

It is not meant for user-based systems, but for times when you want a block of IPs to be able to access a site, and that access is simply on/off - no preferences, etc.

Author: Chuck Hagenbuch ([email protected])

Inheritance: extends Horde_Auth_Base

Show file Open project: horde/horde

Protected Properties

Property	Type	Description
$_capabilities	array	An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

Public Methods

Method	Description
__construct ( array $params = [] )	Constructor.
transparent ( ) : boolean	Automatic authentication: Find out if the client matches an allowed IP block.

Protected Methods

Method	Description
_addressWithinCIDR ( string $address, string $cidr ) : boolean	Determine if an IP address is within a CIDR block.
_authenticate ( string $userId, array $credentials )	Not implemented

Method Details

__construct() public method

Constructor.

public __construct ( array $params = [] )
$params	array	Optional Parameters: 'blocks' - (array) CIDR masks which are allowed access.

_addressWithinCIDR() protected method

Determine if an IP address is within a CIDR block.

protected _addressWithinCIDR ( string $address, string $cidr ) : boolean
$address	string	The IP address to check.
$cidr	string	The block (e.g. 192.168.0.0/16) to test against.
return	boolean	Whether or not the address matches the mask.

_authenticate() protected method

Not implemented

protected _authenticate ( string $userId, array $credentials )
$userId	string	The userID to check.
$credentials	array	An array of login credentials.

transparent() public method

Automatic authentication: Find out if the client matches an allowed IP block.

public transparent ( ) : boolean
return	boolean	Whether or not the client is allowed.

Property Details

$_capabilities protected property

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

protected array $_capabilities
return	array