sspmod_expirycheck_Auth_Process_ExpiryDate Class Reference

Inheritance diagram for sspmod_expirycheck_Auth_Process_ExpiryDate:

Collaboration diagram for sspmod_expirycheck_Auth_Process_ExpiryDate:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter. More...
	shWarning (&$state, $expireOnDate, $warndaysbefore)
	Show expirational warning if remaining days is equal or under defined $warndaysbefore. More...
	checkDate ($expireOnDate)
	Check if given date is older than today. More...
	process (&$state)
	Apply filter. More...
Public Member Functions inherited from SimpleSAML_Auth_ProcessingFilter
	__construct (&$config, $reserved)
	Constructor for a processing filter. More...
	process (&$request)
	Process a request. More...

Private Attributes
	$warndaysbefore = 0
	$netid_attr = NULL
	$expirydate_attr = NULL
	$date_format = 'd.m.Y'

Additional Inherited Members
Data Fields inherited from SimpleSAML_Auth_ProcessingFilter
	$priority = 50
	Priority of this filter. More...

Detailed Description

Definition at line 23 of file ExpiryDate.php.

Constructor & Destructor Documentation

__construct()

sspmod_expirycheck_Auth_Process_ExpiryDate::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

array	$config	Configuration information about this filter.
mixed	$reserved	For future use.

Definition at line 37 of file ExpiryDate.php.

References $config.

                                                        {
                parent::__construct($config, $reserved);

                assert(is_array($config));

                if (array_key_exists('warndaysbefore', $config)) {
                        $this->warndaysbefore = $config['warndaysbefore'];
                        if (!is_string($this->warndaysbefore)) {
                                throw new Exception('Invalid value for number of days given to expirycheck::ExpiryDate filter.');
                        }
                }

                if (array_key_exists('netid_attr', $config)) {
                        $this->netid_attr = $config['netid_attr'];
                        if (!is_string($this->netid_attr)) {
                                throw new Exception('Invalid attribute name given as eduPersonPrincipalName to expirycheck::ExpiryDate filter.');
                        }
                }

                if (array_key_exists('expirydate_attr', $config)) {
                        $this->expirydate_attr = $config['expirydate_attr'];
                        if (!is_string($this->expirydate_attr)) {
                                throw new Exception('Invalid attribute name given as schacExpiryDate to expirycheck::ExpiryDate filter.');
                        }
                }

                if (array_key_exists('date_format', $config)) {
                        $this->date_format = $config['date_format'];
                        if (!is_string($this->date_format)) {
                                throw new Exception('Invalid date format given to expirycheck::ExpiryDate filter.');
                        }
                }
        }

Member Function Documentation

checkDate()

sspmod_expirycheck_Auth_Process_ExpiryDate::checkDate

(

$expireOnDate

)

Check if given date is older than today.

Parameters

integer

$expireOnDate

Returns

bool

Definition at line 98 of file ExpiryDate.php.

References $end.

                                                 {
                $now = time();
                $end = $expireOnDate;

                if ($now <= $end) {
                        return true;
                } else {
                        return false;
                }

        }

process()

sspmod_expirycheck_Auth_Process_ExpiryDate::process

(

&

$state

)

Apply filter.

Parameters

array

&$state

The current state.

Definition at line 115 of file ExpiryDate.php.

References $id, $netid_attr, $state, $url, SimpleSAML\Logger\error(), SimpleSAML\Module\getModuleURL(), SimpleSAML\Utils\HTTP\redirectTrustedURL(), SimpleSAML_Auth_State\saveState(), and SimpleSAML\Logger\warning().

                                         {
                /*
                 * UTC format: 20090527080352Z
                 */
                $netId = $state['Attributes'][$this->netid_attr][0];
                $expireOnDate = strtotime($state['Attributes'][$this->expirydate_attr][0]);

                if (self::shWarning($state, $expireOnDate, $this->warndaysbefore)) {
                        assert(is_array($state));
                        if (isset($state['isPassive']) && $state['isPassive'] === TRUE) {
                                // We have a passive request. Skip the warning.
                                return;
                        }

                        SimpleSAML\Logger::warning('expirycheck: NetID ' . $netId .
                                                   ' is about to expire!');

                        // Save state and redirect
                        $state['expireOnDate'] = date($this->date_format, $expireOnDate);
                        $state['netId'] = $netId;
                        $id = SimpleSAML_Auth_State::saveState($state, 'expirywarning:about2expire');
                        $url = SimpleSAML\Module::getModuleURL('expirycheck/about2expire.php');
                        \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, array('StateId' => $id));
                }

                if (!self::checkDate($expireOnDate)) {
                        SimpleSAML\Logger::error('expirycheck: NetID ' . $netId .
                                ' has expired [' . date($this->date_format, $expireOnDate) . ']. Access denied!');

                        /* Save state and redirect. */
                        $state['expireOnDate'] = date($this->date_format, $expireOnDate);
                        $state['netId'] = $netId;
                        $id = SimpleSAML_Auth_State::saveState($state, 'expirywarning:expired');
                        $url = SimpleSAML\Module::getModuleURL('expirycheck/expired.php');
                        \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, array('StateId' => $id));

                }
        }

Here is the call graph for this function:

shWarning()

sspmod_expirycheck_Auth_Process_ExpiryDate::shWarning	(	&	$state,
			$expireOnDate,
			$warndaysbefore
	)

Show expirational warning if remaining days is equal or under defined $warndaysbefore.

Parameters

integer	$expireOnDate
integer	$warndaysbefore

Returns

bool

Definition at line 78 of file ExpiryDate.php.

References $end, $state, and $warndaysbefore.

                                                                           {
                $now = time();
                $end = $expireOnDate;

                if ($expireOnDate >= $now) {
                        $days = (int)(($end - $now) / (24*60*60));
                        if ($days <= $warndaysbefore) {
                                $state['daysleft'] = $days;
                                return true;
                        }
                }
                return false;
        }

Field Documentation

$date_format

sspmod_expirycheck_Auth_Process_ExpiryDate::$date_format = 'd.m.Y'

private

Definition at line 28 of file ExpiryDate.php.

$expirydate_attr

sspmod_expirycheck_Auth_Process_ExpiryDate::$expirydate_attr = NULL

private

Definition at line 27 of file ExpiryDate.php.

$netid_attr

sspmod_expirycheck_Auth_Process_ExpiryDate::$netid_attr = NULL

private

Definition at line 26 of file ExpiryDate.php.

Referenced by process().

$warndaysbefore

sspmod_expirycheck_Auth_Process_ExpiryDate::$warndaysbefore = 0

private

Definition at line 25 of file ExpiryDate.php.

Referenced by shWarning().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/expirycheck/lib/Auth/Process/ExpiryDate.php