sspmod_authX509_Auth_Process_ExpiryWarning Class Reference

Inheritance diagram for sspmod_authX509_Auth_Process_ExpiryWarning:

Collaboration diagram for sspmod_authX509_Auth_Process_ExpiryWarning:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter. More...
	process (&$state)
	Process an authentication response. 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 = 30
	$renewurl = null

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

Detailed Description

Definition at line 17 of file ExpiryWarning.php.

Constructor & Destructor Documentation

__construct()

sspmod_authX509_Auth_Process_ExpiryWarning::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

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

Definition at line 29 of file ExpiryWarning.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 \'warndaysbefore\'-option to authX509::ExpiryWarning filter.');
            }
        }

        if (array_key_exists('renewurl', $config)) {
            $this->renewurl = $config['renewurl'];
            if (!is_string($this->renewurl)) {
                throw new Exception('Invalid value for \'renewurl\'-option to authX509::ExpiryWarning filter.');
            }
        }
    }

Member Function Documentation

process()

sspmod_authX509_Auth_Process_ExpiryWarning::process

(

&

$state

)

Process an authentication response.

This function saves the state, and if necessary redirects the user to the page where the user is informed about the expiry date of his/her certificate.

Parameters

array

$state

The state of the response.

Definition at line 58 of file ExpiryWarning.php.

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

    {
        assert(is_array($state));

        if (isset($state['isPassive']) && $state['isPassive'] === true) {
            // We have a passive request. Skip the warning
            return;
        }

        if (!isset($_SERVER['SSL_CLIENT_CERT']) ||
            ($_SERVER['SSL_CLIENT_CERT'] == '')) {
            return;
        }

        $client_cert = $_SERVER['SSL_CLIENT_CERT'];
        $client_cert_data = openssl_x509_parse($client_cert);
        if ($client_cert_data == false) {
            SimpleSAML\Logger::error('authX509: invalid cert');
            return;
        }
        $validTo = $client_cert_data['validTo_time_t'];
        $now = time();
        $daysleft = (int)(($validTo - $now) / (24*60*60));
        if ($daysleft > $this->warndaysbefore) {
            // We have a certificate that will be valid for some time. Skip the warning
            return;
        }

        SimpleSAML\Logger::warning('authX509: user certificate expires in ' . $daysleft . ' days');
        $state['daysleft'] = $daysleft;
        $state['renewurl'] = $this->renewurl;

        /* Save state and redirect. */
        $id = SimpleSAML_Auth_State::saveState($state, 'warning:expire');
        $url = SimpleSAML\Module::getModuleURL('authX509/expirywarning.php');
        \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, array('StateId' => $id));
    }

Here is the call graph for this function:

Field Documentation

$renewurl

sspmod_authX509_Auth_Process_ExpiryWarning::$renewurl = null

private

Definition at line 21 of file ExpiryWarning.php.

Referenced by process().

$warndaysbefore

sspmod_authX509_Auth_Process_ExpiryWarning::$warndaysbefore = 30

private

Definition at line 20 of file ExpiryWarning.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/authX509/lib/Auth/Process/ExpiryWarning.php