File: ConsentTest.php

package info (click to toggle)
simplesamlphp 1.19.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 43,240 kB
  • sloc: php: 200,806; javascript: 15,025; xml: 3,336; sh: 265; perl: 82; makefile: 70; python: 5
file content (251 lines) | stat: -rw-r--r-- 9,069 bytes parent folder | download | duplicates (3)
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<?php
/**
 * Test for the consent:Consent authproc filter.
 *
 * @author Vincent Rioux <vrioux@ctech.ca>
 * @package SimpleSAMLphp
 */

namespace SimpleSAML\Test\Module\consent\Auth\Process;

use PHPUnit\Framework\TestCase;
use SimpleSAML\Configuration;
use SimpleSAML\Module\consent\Auth\Process\Consent;

class ConsentTest extends TestCase
{
    /**
     * @return void
     */
    public function setUp()
    {
        $this->config = Configuration::loadFromArray(['module.enable' => ['consent' => true]], '[ARRAY]', 'simplesaml');
        Configuration::setPreLoadedConfig($this->config, 'config.php');
    }


    /**
     * Helper function to run the filter with a given configuration.
     *
     * @param array $config  The filter configuration.
     * @param array $request  The request state.
     * @return array  The state array after processing.
     */
    private function processFilter(array $config, array $request)
    {
        $filter = new Consent($config, null);
        $filter->process($request);
        return $request;
    }


    /**
     * Test for the private checkDisable() method.
     *
     * @return void
     */
    public function testCheckDisable()
    {
        // test consent disable regex with match
        $config = [];

        // test consent disable with match on specific SP entityid
        $request = [
            'Source'     => [
                'entityid' => 'https://idp.example.org',
                'metadata-set' => 'saml20-idp-local',
                'consent.disable' => [
                    'https://valid.flatstring.example.that.does.not.match',
                ],
                'SingleSignOnService' => [
                    [
                        'Binding'  => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect',
                        'Location' => 'https://idp.example.org/saml2/idp/SSOService.php',
                    ],
                ],
            ],
            'Destination' => [
                // valid entityid equal to the last one in the consent.disable array
                'entityid' => 'https://sp.example.org/my-sp',
                'metadata-set' => 'saml20-sp-remote',
                'consent.disable' => [
                    ['type' => 'regex', 'pattern' => '/invalid/i'],
                    'https://sp.example.org/my-sp', // accept the SP that has this specific entityid
                    'https://idp.example.org',
                ],
            ],
            'UserID' => 'jdoe',
            'Attributes' => [
                'eduPersonPrincipalName' => ['jdoe@example.com'],
            ],
        ];
        $result = $this->processFilter($config, $request);
        // the state should NOT have changed because NO consent should be necessary (match)
        $this->assertEquals($request, $result);

        // test consent disable with match on SP through regular expression
        $request = [
            'Source'     => [
                'entityid' => 'https://idp.example.org',
                'metadata-set' => 'saml20-idp-local',
                'consent.disable' => [
                    [], // invalid consent option array should be ignored
                    1234, // bad option
                    [''], // no type
                    ['type'=>'invalid'], // invalid consent option type should be ignored
                    ['type'=>'regex'], // regex consent option without pattern should be ignored
                    ['type'=>'regex', 'pattern'=>'/.*\.valid.regex\.that\.does\.not\.match.*/i'],
                    // accept any SP that has an entityid that contains the string ".example.org"
                    ['type'=>'regex', 'pattern'=>'/.*\.example\.org\/.*/i'],
                ],
                'SingleSignOnService' => [
                    [
                        'Binding'  => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect',
                        'Location' => 'https://idp.example.org/saml2/idp/SSOService.php',
                    ],
                ],
            ],
            'Destination' => [
                'entityid' => 'https://sp.example.org/my-sp', // sp contains the string ".example.org"
                'metadata-set' => 'saml20-sp-remote',
            ],
            'UserID' => 'jdoe',
            'Attributes' => [
                'eduPersonPrincipalName' => ['jdoe@example.com'],
            ],
        ];
        $result = $this->processFilter($config, $request);
        // the state should NOT have changed because NO consent should be necessary (match)
        $this->assertEquals($request, $result);

        // test corner cases
        $request['Source']['consent.disable'] = [
            'https://valid.flatstring.example.that.does.not.match',
            ['foo' => 'bar'],
        ];
        $request['Destination']['consent.disable'] = 1;
        $result = $this->processFilter($config, $request);
        // the state should NOT have changed because NO consent should be necessary (match)
        $this->assertEquals($request, $result);
    }


    /**
     * @return void
     */
    public function testAttributeHashIsConsistentWhenOrderOfValuesChange()
    {
        $attributes1 = [
            'attribute1' => ['val1', 'val2'],
            'attribute2' => ['val1', 'val2']
        ];
        $attributeHash1 = Consent::getAttributeHash($attributes1, true);

        $attributes2 = [
            'attribute1' => ['val1', 'val2'],
            'attribute2' => ['val2', 'val1']
        ];
        $attributeHash2 = Consent::getAttributeHash($attributes2, true);

        $this->assertEquals($attributeHash1, $attributeHash2, "Hash is not the same when the order of values changes");
    }


    /**
     * @return void
     */
    public function testAttributeHashIsConsistentWhenOrderOfAttributesChange()
    {
        $attributes1 = [
            'attribute2' => ['val1', 'val2'],
            'attribute1' => ['val1', 'val2']
        ];
        $attributeHash1 = Consent::getAttributeHash($attributes1, true);

        $attributes2 = [
            'attribute1' => ['val1', 'val2'],
            'attribute2' => ['val1', 'val2']
        ];
        $attributeHash2 = Consent::getAttributeHash($attributes2, true);

        $this->assertEquals(
            $attributeHash1,
            $attributeHash2,
            "Hash is not the same when the order of the attributs changes"
        );
    }


    /**
     * @return void
     */
    public function testAttributeHashIsConsistentWithoutValuesWhenOrderOfAttributesChange()
    {
        $attributes1 = [
            'attribute2' => ['val1', 'val2'],
            'attribute1' => ['val1', 'val2']
        ];
        $attributeHash1 = Consent::getAttributeHash($attributes1);

        $attributes2 = [
            'attribute1' => ['val1', 'val2'],
            'attribute2' => ['val1', 'val2']
        ];
        $attributeHash2 = Consent::getAttributeHash($attributes2);

        $this->assertEquals(
            $attributeHash1,
            $attributeHash2,
            "Hash is not the same when the order of the attributs changes and the values are not included"
        );
    }


    /**
     * @return void
     */
    public function testConstructorSetsInstancePrivateVars()
    {
        $reflection = new \ReflectionClass(Consent::class);

        $values = [
            'includeValues',
            'checked',
            'focus',
            'hiddenAttributes',
            'noconsentattributes',
            'showNoConsentAboutService'
        ];
        foreach ($values as $v) {
            $instanceVars[$v] = $reflection->getProperty($v);
            $instanceVars[$v]->setAccessible(true);
        }

        /* these just need to be different to the default values */
        $config = [
            'includeValues' => true,
            'checked' => true,
            'focus' => 'yes',
            'hiddenAttributes' => ['attribute1', 'attribute2'],
            'attributes.exclude' => ['attribute1', 'attribute2'],
            'showNoConsentAboutService' => false,
        ];

        ob_start();
        $testcase = $reflection->newInstance($config, null);
        ob_end_clean();

        $this->assertEquals($instanceVars['includeValues']->getValue($testcase), $config['includeValues']);
        $this->assertEquals($instanceVars['checked']->getValue($testcase), $config['checked']);
        $this->assertEquals($instanceVars['focus']->getValue($testcase), $config['focus']);
        $this->assertEquals($instanceVars['hiddenAttributes']->getValue($testcase), $config['hiddenAttributes']);
        $this->assertEquals($instanceVars['noconsentattributes']->getValue($testcase), $config['attributes.exclude']);
        $this->assertEquals(
            $instanceVars['showNoConsentAboutService']->getValue($testcase),
            $config['showNoConsentAboutService']
        );

        $deprecated = $reflection->newInstance(['noconsentattributes' => $config['attributes.exclude']], null);
        $this->assertEquals($instanceVars['noconsentattributes']->getValue($deprecated), $config['attributes.exclude']);
    }
}