CAS_ProxyChain_AllowedList Class Reference

ProxyChain is a container for storing chains of valid proxies that can be used to validate proxied requests to a service. More...

Collaboration diagram for CAS_ProxyChain_AllowedList:

Public Member Functions
	isProxyingAllowed ()
	Check whether proxies are allowed by configuration. More...
	allowProxyChain (CAS_ProxyChain_Interface $chain)
	Add a chain of proxies to the list of possible chains. More...
	isProxyListAllowed (array $proxies)
	Check if the proxies found in the response match the allowed proxies. More...
	contains (array $list)
	Validate the proxies from the proxy ticket validation against the chains that were definded. More...

Private Attributes
	$_chains = array()

Detailed Description

ProxyChain is a container for storing chains of valid proxies that can be used to validate proxied requests to a service.

Definition at line 43 of file AllowedList.php.

Member Function Documentation

allowProxyChain()

CAS_ProxyChain_AllowedList::allowProxyChain

(

CAS_ProxyChain_Interface

$chain

)

Add a chain of proxies to the list of possible chains.

Parameters

CAS_ProxyChain_Interface

$chain

A chain of proxies

Returns

void

Definition at line 65 of file AllowedList.php.

    {
        $this->_chains[] = $chain;
    }

contains()

CAS_ProxyChain_AllowedList::contains

(

array

$list

)

Validate the proxies from the proxy ticket validation against the chains that were definded.

Parameters

array

$list

List of proxies from the proxy ticket validation.

Returns

if any chain fully matches the supplied list

Definition at line 103 of file AllowedList.php.

References phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by isProxyListAllowed().

    {
        phpCAS::traceBegin();
        $count = 0;
        foreach ($this->_chains as $chain) {
            phpCAS::trace("Checking chain ". $count++);
            if ($chain->matches($list)) {
                phpCAS::traceEnd(true);
                return true;
            }
        }
        phpCAS::trace("No proxy chain matches.");
        phpCAS::traceEnd(false);
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isProxyingAllowed()

CAS_ProxyChain_AllowedList::isProxyingAllowed

(

)

Check whether proxies are allowed by configuration.

Returns

bool

Definition at line 53 of file AllowedList.php.

Referenced by isProxyListAllowed().

    {
        return (count($this->_chains) > 0);
    }

Here is the caller graph for this function:

isProxyListAllowed()

CAS_ProxyChain_AllowedList::isProxyListAllowed

(

array

$proxies

)

Check if the proxies found in the response match the allowed proxies.

Parameters

array

$proxies

list of proxies to check

Returns

bool whether the proxies match the allowed proxies

Definition at line 77 of file AllowedList.php.

References $res, contains(), isProxyingAllowed(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();
        if (empty($proxies)) {
            phpCAS::trace("No proxies were found in the response");
            phpCAS::traceEnd(true);
            return true;
        } elseif (!$this->isProxyingAllowed()) {
            phpCAS::trace("Proxies are not allowed");
            phpCAS::traceEnd(false);
            return false;
        } else {
            $res = $this->contains($proxies);
            phpCAS::traceEnd($res);
            return $res;
        }
    }

Here is the call graph for this function:

Field Documentation

$_chains

CAS_ProxyChain_AllowedList::$_chains = array()

private

Definition at line 46 of file AllowedList.php.

---

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

• Services/CAS/lib/CAS/ProxyChain/AllowedList.php