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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Bundle\SecurityBundle\Tests\Functional;
use Jose\Component\Core\AlgorithmManager;
use Jose\Component\Core\JWK;
use Jose\Component\Signature\Algorithm\ES256;
use Jose\Component\Signature\JWSBuilder;
use Jose\Component\Signature\Serializer\CompactSerializer;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\HttpFoundation\Response;
class AccessTokenTest extends AbstractWebTestCase
{
public function testNoTokenHandlerConfiguredShouldFail()
{
$this->expectException(InvalidConfigurationException::class);
$this->expectExceptionMessage('The child config "token_handler" under "security.firewalls.main.access_token" must be configured.');
$this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_no_handler.yml']);
}
public function testNoTokenExtractorsConfiguredShouldFail()
{
$this->expectException(InvalidConfigurationException::class);
$this->expectExceptionMessage('The path "security.firewalls.main.access_token.token_extractors" should have at least 1 element(s) defined.');
$this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_no_extractors.yml']);
}
public function testAnonymousAccessIsGranted()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_anonymous.yml']);
$client->request('GET', '/bar');
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome anonymous!'], json_decode($response->getContent(), true));
}
public function testDefaultFormEncodedBodySuccess()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_body_default.yml']);
$client->request('POST', '/foo', ['access_token' => 'VALID_ACCESS_TOKEN'], [], ['CONTENT_TYPE' => 'application/x-www-form-urlencoded']);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome @dunglas!'], json_decode($response->getContent(), true));
}
/**
* @dataProvider defaultFormEncodedBodyFailureData
*/
public function testDefaultFormEncodedBodyFailure(array $parameters, array $headers)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_body_default.yml']);
$client->request('POST', '/foo', $parameters, [], $headers);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
$this->assertSame('', $response->getContent());
$this->assertSame('Bearer realm="My API",error="invalid_token",error_description="Invalid credentials."', $response->headers->get('WWW-Authenticate'));
}
public function testDefaultMissingFormEncodedBodyFail()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_body_default.yml']);
$client->request('GET', '/foo');
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
}
public function testCustomFormEncodedBodySuccess()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_body_custom.yml']);
$client->request('POST', '/foo', ['secured_token' => 'VALID_ACCESS_TOKEN'], [], ['CONTENT_TYPE' => 'application/x-www-form-urlencoded']);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Good game @dunglas!'], json_decode($response->getContent(), true));
}
/**
* @dataProvider customFormEncodedBodyFailure
*/
public function testCustomFormEncodedBodyFailure(array $parameters, array $headers)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_body_custom.yml']);
$client->request('POST', '/foo', $parameters, [], $headers);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(500, $response->getStatusCode());
$this->assertSame(['message' => 'Something went wrong'], json_decode($response->getContent(), true));
$this->assertFalse($response->headers->has('WWW-Authenticate'));
}
public function testCustomMissingFormEncodedBodyShouldFail()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_body_custom.yml']);
$client->request('POST', '/foo');
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
}
public static function defaultFormEncodedBodyFailureData(): iterable
{
yield [['access_token' => 'INVALID_ACCESS_TOKEN'], ['CONTENT_TYPE' => 'application/x-www-form-urlencoded']];
}
public static function customFormEncodedBodyFailure(): iterable
{
yield [['secured_token' => 'INVALID_ACCESS_TOKEN'], ['CONTENT_TYPE' => 'application/x-www-form-urlencoded']];
}
public function testDefaultHeaderAccessTokenSuccess()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_header_default.yml']);
$client->request('GET', '/foo', [], [], ['HTTP_AUTHORIZATION' => 'Bearer VALID_ACCESS_TOKEN']);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome @dunglas!'], json_decode($response->getContent(), true));
}
public function testMultipleAccessTokenExtractorSuccess()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_multiple_extractors.yml']);
$client->request('GET', '/foo', [], [], ['HTTP_AUTHORIZATION' => 'Bearer VALID_ACCESS_TOKEN']);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome @dunglas!'], json_decode($response->getContent(), true));
}
/**
* @dataProvider defaultHeaderAccessTokenFailureData
*/
public function testDefaultHeaderAccessTokenFailure(array $headers)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_header_default.yml']);
$client->request('GET', '/foo', [], [], $headers);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
$this->assertSame('', $response->getContent());
$this->assertSame('Bearer realm="My API",error="invalid_token",error_description="Invalid credentials."', $response->headers->get('WWW-Authenticate'));
}
/**
* @dataProvider defaultMissingHeaderAccessTokenFailData
*/
public function testDefaultMissingHeaderAccessTokenFail(array $headers)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_header_default.yml']);
$client->request('GET', '/foo', [], [], $headers);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
}
public function testCustomHeaderAccessTokenSuccess()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_header_custom.yml']);
$client->request('GET', '/foo', [], [], ['HTTP_X_AUTH_TOKEN' => 'VALID_ACCESS_TOKEN']);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Good game @dunglas!'], json_decode($response->getContent(), true));
}
/**
* @dataProvider customHeaderAccessTokenFailure
*/
public function testCustomHeaderAccessTokenFailure(array $headers, int $errorCode)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_header_custom.yml']);
$client->request('GET', '/foo', [], [], $headers);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame($errorCode, $response->getStatusCode());
$this->assertFalse($response->headers->has('WWW-Authenticate'));
}
/**
* @dataProvider customMissingHeaderAccessTokenShouldFail
*/
public function testCustomMissingHeaderAccessTokenShouldFail(array $headers)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_header_custom.yml']);
$client->request('GET', '/foo', [], [], $headers);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
}
public static function defaultHeaderAccessTokenFailureData(): iterable
{
yield [['HTTP_AUTHORIZATION' => 'Bearer INVALID_ACCESS_TOKEN']];
}
public static function defaultMissingHeaderAccessTokenFailData(): iterable
{
yield [['HTTP_AUTHORIZATION' => 'JWT INVALID_TOKEN_TYPE']];
yield [['HTTP_X_FOO' => 'Missing-Header']];
yield [['HTTP_X_AUTH_TOKEN' => 'this is not a token']];
}
public static function customHeaderAccessTokenFailure(): iterable
{
yield [['HTTP_X_AUTH_TOKEN' => 'INVALID_ACCESS_TOKEN'], 500];
}
public static function customMissingHeaderAccessTokenShouldFail(): iterable
{
yield [[]];
yield [['HTTP_AUTHORIZATION' => 'Bearer this is not a token']];
}
public function testDefaultQueryAccessTokenSuccess()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_query_default.yml']);
$client->request('GET', '/foo?access_token=VALID_ACCESS_TOKEN');
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome @dunglas!'], json_decode($response->getContent(), true));
}
/**
* @dataProvider defaultQueryAccessTokenFailureData
*/
public function testDefaultQueryAccessTokenFailure(string $query)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_query_default.yml']);
$client->request('GET', $query);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
$this->assertSame('', $response->getContent());
$this->assertSame('Bearer realm="My API",error="invalid_token",error_description="Invalid credentials."', $response->headers->get('WWW-Authenticate'));
}
public function testDefaultMissingQueryAccessTokenFail()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_query_default.yml']);
$client->request('GET', '/foo');
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
}
public function testCustomQueryAccessTokenSuccess()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_query_custom.yml']);
$client->request('GET', '/foo?protection_token=VALID_ACCESS_TOKEN');
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Good game @dunglas!'], json_decode($response->getContent(), true));
}
/**
* @dataProvider customQueryAccessTokenFailure
*/
public function testCustomQueryAccessTokenFailure(string $query)
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_query_custom.yml']);
$client->request('GET', $query);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(500, $response->getStatusCode());
$this->assertSame(['message' => 'Something went wrong'], json_decode($response->getContent(), true));
$this->assertFalse($response->headers->has('WWW-Authenticate'));
}
public function testCustomMissingQueryAccessTokenShouldFail()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_query_custom.yml']);
$client->request('GET', '/foo');
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(401, $response->getStatusCode());
}
public static function defaultQueryAccessTokenFailureData(): iterable
{
yield ['/foo?access_token=INVALID_ACCESS_TOKEN'];
}
public static function customQueryAccessTokenFailure(): iterable
{
yield ['/foo?protection_token=INVALID_ACCESS_TOKEN'];
}
public function testSelfContainedTokens()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_self_contained_token.yml']);
$client->catchExceptions(false);
$client->request('GET', '/foo', [], [], ['HTTP_AUTHORIZATION' => 'Bearer SELF_CONTAINED_ACCESS_TOKEN']);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome @dunglas!'], json_decode($response->getContent(), true));
}
public function testCustomUserLoader()
{
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_custom_user_loader.yml']);
$client->catchExceptions(false);
$client->request('GET', '/foo', [], [], ['HTTP_AUTHORIZATION' => 'Bearer SELF_CONTAINED_ACCESS_TOKEN']);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome @dunglas!'], json_decode($response->getContent(), true));
}
/**
* @requires extension openssl
* @group jwt
*/
public function testOidcSuccess()
{
$time = time();
$claims = [
'iat' => $time,
'nbf' => $time,
'exp' => $time + 3600,
'iss' => 'https://www.example.com',
'aud' => 'Symfony OIDC',
'sub' => 'e21bf182-1538-406e-8ccb-e25a17aba39f',
'username' => 'dunglas',
];
$token = (new CompactSerializer())->serialize((new JWSBuilder(new AlgorithmManager([
new ES256(),
])))->create()
->withPayload(json_encode($claims))
// tip: use https://mkjwk.org/ to generate a JWK
->addSignature(new JWK([
'kty' => 'EC',
'crv' => 'P-256',
'x' => '0QEAsI1wGI-dmYatdUZoWSRWggLEpyzopuhwk-YUnA4',
'y' => 'KYl-qyZ26HobuYwlQh-r0iHX61thfP82qqEku7i0woo',
'd' => 'iA_TV2zvftni_9aFAQwFO_9aypfJFCSpcCyevDvz220',
]), ['alg' => 'ES256'])
->build()
);
$client = $this->createClient(['test_case' => 'AccessToken', 'root_config' => 'config_oidc.yml']);
$client->request('GET', '/foo', [], [], ['HTTP_AUTHORIZATION' => \sprintf('Bearer %s', $token)]);
$response = $client->getResponse();
$this->assertInstanceOf(Response::class, $response);
$this->assertSame(200, $response->getStatusCode());
$this->assertSame(['message' => 'Welcome @dunglas!'], json_decode($response->getContent(), true));
}
}
|
