File: ExpiryDate.php

package info (click to toggle)
simplesamlphp 1.19.7-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 42,920 kB
  • sloc: php: 202,044; javascript: 14,867; xml: 2,700; sh: 225; perl: 82; makefile: 70; python: 5
file content (171 lines) | stat: -rw-r--r-- 5,371 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<?php

namespace SimpleSAML\Module\expirycheck\Auth\Process;

/**
 * Filter which show "about to expire" warning or deny access if netid is expired.
 *
 * Based on preprodwarning module by rnd.feide.no
 *
 * <code>
 * // show about2xpire warning or deny access if netid is expired
 * 10 => array(
 *     'class' => 'expirycheck:ExpiryDate',
 *     'netid_attr' => 'eduPersonPrincipalName',
 *     'expirydate_attr' => 'schacExpiryDate',
 *     'warndaysbefore' => '60',
 *     'date_format' => 'd.m.Y', # php date syntax
 * ),
 * </code>
 *
 * @author Alex Mihičinac, ARNES. <alexm@arnes.si>
 * @package SimpleSAMLphp
 */
class ExpiryDate extends \SimpleSAML\Auth\ProcessingFilter
{
    /** @var int */
    private $warndaysbefore = 0;

    /** @var string|null */
    private $netid_attr = null;

    /** @var string|null */
    private $expirydate_attr = null;

    /** @var string */
    private $date_format = 'd.m.Y';


    /**
     * Initialize this filter.
     *
     * @param array &$config  Configuration information about this filter.
     * @param mixed $reserved  For future use.
     */
    public function __construct(&$config, $reserved)
    {
        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.');
            }
        }
    }


    /**
     * Show expirational warning if remaining days is equal or under defined $warndaysbefore
     *
     * @param array &$state
     * @param int $expireOnDate
     * @param int $warndaysbefore
     * @return bool
     */
    public function shWarning(&$state, $expireOnDate, $warndaysbefore)
    {
        $now = time();
        $end = $expireOnDate;

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


    /**
     * Check if given date is older than today
     *
     * @param int $expireOnDate
     * @return bool
     */
    public function checkDate($expireOnDate)
    {
        $now = time();
        $end = $expireOnDate;

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


    /**
     * Apply filter
     *
     * @param array &$state  The current state.
     * @return void
     */
    public function process(&$state)
    {
        /*
         * UTC format: 20090527080352Z
         */
        $netId = $state['Attributes'][$this->netid_attr][0];
        $expireOnDate = strtotime($state['Attributes'][$this->expirydate_attr][0]);

        if ($this->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, ['StateId' => $id]);
        }

        if (!$this->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, ['StateId' => $id]);
        }
    }
}