1 | <?php |
||
44 | final class SessionMiddlewareTest extends TestCase |
||
45 | { |
||
46 | public function testFromSymmetricKeyDefaultsUsesASecureCookie() : void |
||
56 | |||
57 | public function testFromAsymmetricKeyDefaultsUsesASecureCookie() : void |
||
72 | |||
73 | /** |
||
74 | * @dataProvider validMiddlewaresProvider |
||
75 | */ |
||
76 | public function testSkipsInjectingSessionCookieOnEmptyContainer(SessionMiddleware $middleware) : void |
||
82 | |||
83 | /** |
||
84 | * @dataProvider validMiddlewaresProvider |
||
85 | */ |
||
86 | public function testExtractsSessionContainerFromEmptyRequest(SessionMiddleware $middleware) : void |
||
90 | |||
91 | /** |
||
92 | * @dataProvider validMiddlewaresProvider |
||
93 | */ |
||
94 | public function testInjectsSessionInResponseCookies(SessionMiddleware $middleware) : void |
||
103 | |||
104 | /** |
||
105 | * @dataProvider validMiddlewaresProvider |
||
106 | */ |
||
107 | public function testSessionContainerCanBeReusedOverMultipleRequests(SessionMiddleware $middleware) : void |
||
108 | { |
||
109 | $sessionValue = uniqid('', true); |
||
110 | |||
111 | $checkingMiddleware = $this->fakeDelegate( |
||
112 | function (ServerRequestInterface $request) use ($sessionValue) { |
||
113 | /* @var $session SessionInterface */ |
||
114 | $session = $request->getAttribute(SessionMiddleware::SESSION_ATTRIBUTE); |
||
115 | |||
116 | self::assertSame($sessionValue, $session->get('foo')); |
||
117 | self::assertFalse($session->hasChanged()); |
||
118 | |||
119 | $session->set('foo', $sessionValue . 'changed'); |
||
120 | |||
121 | self::assertTrue( |
||
122 | $session->hasChanged(), |
||
123 | 'ensuring that the cookie is sent again: ' |
||
124 | . 'non-modified session containers are not to be re-serialized into a token' |
||
125 | ); |
||
126 | |||
127 | return new Response(); |
||
128 | } |
||
129 | ); |
||
130 | |||
131 | $firstResponse = $middleware->process(new ServerRequest(), $this->writingMiddleware($sessionValue)); |
||
132 | |||
133 | $response = $middleware->process( |
||
134 | $this->requestWithResponseCookies($firstResponse), |
||
135 | $checkingMiddleware |
||
136 | ); |
||
137 | |||
138 | self::assertNotSame($response, $firstResponse); |
||
139 | } |
||
140 | |||
141 | /** |
||
142 | * @dataProvider validMiddlewaresProvider |
||
143 | */ |
||
144 | public function testWillIgnoreRequestsWithExpiredTokens(SessionMiddleware $middleware) : void |
||
157 | |||
158 | /** |
||
159 | * @dataProvider validMiddlewaresProvider |
||
160 | */ |
||
161 | public function testWillIgnoreRequestsWithTokensFromFuture(SessionMiddleware $middleware) : void |
||
174 | |||
175 | /** |
||
176 | * @dataProvider validMiddlewaresProvider |
||
177 | */ |
||
178 | public function testWillIgnoreUnSignedTokens(SessionMiddleware $middleware) : void |
||
191 | |||
192 | /** |
||
193 | * @dataProvider validMiddlewaresProvider |
||
194 | */ |
||
195 | public function testWillNotRefreshSignedTokensWithoutIssuedAt(SessionMiddleware $middleware) : void |
||
208 | |||
209 | public function testWillRefreshTokenWithIssuedAtExactlyAtTokenRefreshTimeThreshold() : void |
||
210 | { |
||
211 | // forcing ourselves to think of time as a mutable value: |
||
212 | $time = time() + random_int(-100, +100); |
||
213 | |||
214 | $clock = new FrozenClock(new \DateTimeImmutable('@' . $time)); |
||
215 | |||
216 | $middleware = new SessionMiddleware( |
||
217 | new Sha256(), |
||
218 | 'foo', |
||
219 | 'foo', |
||
220 | SetCookie::create(SessionMiddleware::DEFAULT_COOKIE), |
||
221 | new Parser(), |
||
222 | 1000, |
||
223 | $clock, |
||
224 | 100 |
||
225 | ); |
||
226 | |||
227 | $requestWithTokenIssuedInThePast = (new ServerRequest()) |
||
228 | ->withCookieParams([ |
||
229 | SessionMiddleware::DEFAULT_COOKIE => (string) (new Builder()) |
||
230 | ->setExpiration($time + 10000) |
||
231 | ->setIssuedAt($time - 100) |
||
232 | ->set(SessionMiddleware::SESSION_CLAIM, DefaultSessionData::fromTokenData(['foo' => 'bar'])) |
||
233 | ->sign($this->getSigner($middleware), $this->getSignatureKey($middleware)) |
||
234 | ->getToken() |
||
235 | ]); |
||
236 | |||
237 | $cookie = $this->getCookie($middleware->process($requestWithTokenIssuedInThePast, $this->fakeDelegate(function () { |
||
238 | return new Response(); |
||
239 | }))); |
||
240 | |||
241 | $token = (new Parser())->parse($cookie->getValue()); |
||
242 | |||
243 | self::assertEquals($time, $token->getClaim(SessionMiddleware::ISSUED_AT_CLAIM), 'Token was refreshed'); |
||
244 | } |
||
245 | |||
246 | /** |
||
247 | * @dataProvider validMiddlewaresProvider |
||
248 | */ |
||
249 | public function testWillSkipInjectingSessionCookiesWhenSessionIsNotChanged(SessionMiddleware $middleware) : void |
||
250 | { |
||
251 | $this->ensureSameResponse( |
||
252 | $middleware, |
||
253 | $this->requestWithResponseCookies( |
||
254 | $middleware->process(new ServerRequest(), $this->writingMiddleware()) |
||
255 | ), |
||
256 | $this->fakeDelegate( |
||
257 | function (ServerRequestInterface $request) { |
||
258 | /* @var $session SessionInterface */ |
||
259 | $session = $request->getAttribute(SessionMiddleware::SESSION_ATTRIBUTE); |
||
260 | |||
261 | // note: we set the same data just to make sure that we are indeed interacting with the session |
||
262 | $session->set('foo', 'bar'); |
||
263 | |||
264 | self::assertFalse($session->hasChanged()); |
||
265 | |||
266 | return new Response(); |
||
267 | } |
||
268 | ) |
||
269 | ); |
||
270 | } |
||
271 | |||
272 | /** |
||
273 | * @dataProvider validMiddlewaresProvider |
||
274 | */ |
||
275 | public function testWillSendExpirationCookieWhenSessionContentsAreCleared(SessionMiddleware $middleware) : void |
||
276 | { |
||
277 | $this->ensureClearsSessionCookie( |
||
278 | $middleware, |
||
279 | $this->requestWithResponseCookies( |
||
280 | $middleware->process(new ServerRequest(), $this->writingMiddleware()) |
||
281 | ), |
||
282 | $this->fakeDelegate( |
||
283 | function (ServerRequestInterface $request) { |
||
284 | /* @var $session SessionInterface */ |
||
285 | $session = $request->getAttribute(SessionMiddleware::SESSION_ATTRIBUTE); |
||
286 | |||
287 | $session->clear(); |
||
288 | |||
289 | return new Response(); |
||
290 | } |
||
291 | ) |
||
292 | ); |
||
293 | } |
||
294 | |||
295 | /** |
||
296 | * @dataProvider validMiddlewaresProvider |
||
297 | */ |
||
298 | public function testWillIgnoreMalformedTokens(SessionMiddleware $middleware) : void |
||
299 | { |
||
300 | $this->ensureSameResponse( |
||
301 | $middleware, |
||
302 | (new ServerRequest())->withCookieParams([SessionMiddleware::DEFAULT_COOKIE => 'malformed content']), |
||
303 | $this->emptyValidationMiddleware() |
||
304 | ); |
||
305 | } |
||
306 | |||
307 | public function testRejectsTokensWithInvalidSignature() : void |
||
308 | { |
||
309 | $middleware = new SessionMiddleware( |
||
310 | new Sha256(), |
||
311 | 'foo', |
||
312 | 'bar', // wrong symmetric key (on purpose) |
||
313 | SetCookie::create(SessionMiddleware::DEFAULT_COOKIE), |
||
314 | new Parser(), |
||
315 | 100, |
||
316 | new SystemClock() |
||
317 | ); |
||
318 | |||
319 | $this->ensureSameResponse( |
||
320 | $middleware, |
||
321 | $this->requestWithResponseCookies( |
||
322 | $middleware->process(new ServerRequest(), $this->writingMiddleware()) |
||
323 | ), |
||
324 | $this->emptyValidationMiddleware() |
||
325 | ); |
||
326 | } |
||
327 | |||
328 | public function testAllowsModifyingCookieDetails() : void |
||
329 | { |
||
330 | $defaultCookie = SetCookie::create('a-different-cookie-name') |
||
331 | ->withDomain('foo.bar') |
||
332 | ->withPath('/yadda') |
||
333 | ->withHttpOnly(false) |
||
334 | ->withMaxAge('123123') |
||
335 | ->withValue('a-random-value'); |
||
336 | |||
337 | $dateTime = new DateTimeImmutable(); |
||
338 | $middleware = new SessionMiddleware( |
||
339 | new Sha256(), |
||
340 | 'foo', |
||
341 | 'foo', |
||
342 | $defaultCookie, |
||
343 | new Parser(), |
||
344 | 123456, |
||
345 | new FrozenClock($dateTime), |
||
346 | 123 |
||
347 | ); |
||
348 | |||
349 | $response = $middleware->process(new ServerRequest(), $this->writingMiddleware()); |
||
350 | |||
351 | self::assertNull($this->getCookie($response)->getValue()); |
||
352 | |||
353 | $tokenCookie = $this->getCookie($response, 'a-different-cookie-name'); |
||
354 | |||
355 | self::assertNotEmpty($tokenCookie->getValue()); |
||
356 | self::assertNotSame($defaultCookie->getValue(), $tokenCookie->getValue()); |
||
357 | self::assertSame($defaultCookie->getDomain(), $tokenCookie->getDomain()); |
||
358 | self::assertSame($defaultCookie->getPath(), $tokenCookie->getPath()); |
||
359 | self::assertSame($defaultCookie->getHttpOnly(), $tokenCookie->getHttpOnly()); |
||
360 | self::assertSame($defaultCookie->getMaxAge(), $tokenCookie->getMaxAge()); |
||
361 | self::assertEquals($dateTime->getTimestamp() + 123456, $tokenCookie->getExpires()); |
||
362 | } |
||
363 | |||
364 | public function testSessionTokenParsingIsDelayedWhenSessionIsNotBeingUsed() : void |
||
365 | { |
||
366 | /* @var $signer Signer|\PHPUnit_Framework_MockObject_MockObject */ |
||
367 | $signer = $this->createMock(Signer::class); |
||
368 | |||
369 | $signer->expects($this->never())->method('verify'); |
||
|
|||
370 | $signer->method('getAlgorithmId')->willReturn('HS256'); |
||
371 | |||
372 | $currentTimeProvider = new SystemClock(); |
||
373 | $setCookie = SetCookie::create(SessionMiddleware::DEFAULT_COOKIE); |
||
374 | $middleware = new SessionMiddleware($signer, 'foo', 'foo', $setCookie, new Parser(), 100, $currentTimeProvider); |
||
375 | $request = (new ServerRequest()) |
||
376 | ->withCookieParams([ |
||
377 | SessionMiddleware::DEFAULT_COOKIE => (string) (new Builder()) |
||
378 | ->set(SessionMiddleware::SESSION_CLAIM, DefaultSessionData::fromTokenData(['foo' => 'bar'])) |
||
379 | ->setIssuedAt(time()) |
||
380 | ->sign(new Sha256(), 'foo') |
||
381 | ->getToken() |
||
382 | ]); |
||
383 | |||
384 | $middleware->process( |
||
385 | $request, |
||
386 | $this->fakeDelegate(function (ServerRequestInterface $request) { |
||
387 | self::assertInstanceOf( |
||
388 | SessionInterface::class, |
||
389 | $request->getAttribute(SessionMiddleware::SESSION_ATTRIBUTE) |
||
390 | ); |
||
391 | |||
392 | return new Response(); |
||
393 | }) |
||
394 | ); |
||
395 | } |
||
396 | |||
397 | public function testShouldRegenerateTokenWhenRequestHasATokenThatIsAboutToExpire() : void |
||
398 | { |
||
399 | $dateTime = new DateTimeImmutable(); |
||
400 | $middleware = new SessionMiddleware( |
||
401 | new Sha256(), |
||
402 | 'foo', |
||
403 | 'foo', |
||
404 | SetCookie::create(SessionMiddleware::DEFAULT_COOKIE), |
||
405 | new Parser(), |
||
406 | 1000, |
||
407 | new FrozenClock($dateTime), |
||
408 | 300 |
||
409 | ); |
||
410 | |||
411 | $expiringToken = (new ServerRequest()) |
||
412 | ->withCookieParams([ |
||
413 | SessionMiddleware::DEFAULT_COOKIE => (string) (new Builder()) |
||
414 | ->setIssuedAt((new \DateTime('-800 second'))->getTimestamp()) |
||
415 | ->setExpiration((new \DateTime('+200 second'))->getTimestamp()) |
||
416 | ->set(SessionMiddleware::SESSION_CLAIM, DefaultSessionData::fromTokenData(['foo' => 'bar'])) |
||
417 | ->sign($this->getSigner($middleware), $this->getSignatureKey($middleware)) |
||
418 | ->getToken() |
||
419 | ]); |
||
420 | |||
421 | $initialResponse = new Response(); |
||
422 | |||
423 | $response = $middleware->process($expiringToken, $this->fakeDelegate(function () use ($initialResponse) { |
||
424 | return $initialResponse; |
||
425 | })); |
||
426 | |||
427 | self::assertNotSame($initialResponse, $response); |
||
428 | |||
429 | $tokenCookie = $this->getCookie($response); |
||
430 | |||
431 | self::assertNotEmpty($tokenCookie->getValue()); |
||
432 | self::assertEquals($dateTime->getTimestamp() + 1000, $tokenCookie->getExpires()); |
||
433 | } |
||
434 | |||
435 | public function testShouldNotRegenerateTokenWhenRequestHasATokenThatIsFarFromExpiration() : void |
||
436 | { |
||
437 | $middleware = new SessionMiddleware( |
||
438 | new Sha256(), |
||
439 | 'foo', |
||
440 | 'foo', |
||
441 | SetCookie::create(SessionMiddleware::DEFAULT_COOKIE), |
||
442 | new Parser(), |
||
443 | 1000, |
||
444 | new SystemClock(), |
||
445 | 300 |
||
446 | ); |
||
447 | |||
448 | $validToken = (new ServerRequest()) |
||
449 | ->withCookieParams([ |
||
450 | SessionMiddleware::DEFAULT_COOKIE => (string) (new Builder()) |
||
451 | ->setIssuedAt((new \DateTime('-100 second'))->getTimestamp()) |
||
452 | ->setExpiration((new \DateTime('+900 second'))->getTimestamp()) |
||
453 | ->set(SessionMiddleware::SESSION_CLAIM, DefaultSessionData::fromTokenData(['foo' => 'bar'])) |
||
454 | ->sign($this->getSigner($middleware), $this->getSignatureKey($middleware)) |
||
455 | ->getToken() |
||
456 | ]); |
||
457 | |||
458 | $this->ensureSameResponse($middleware, $validToken); |
||
459 | } |
||
460 | |||
461 | /** |
||
462 | * @return SessionMiddleware[][] |
||
463 | */ |
||
464 | public function validMiddlewaresProvider() : array |
||
465 | { |
||
466 | return [ |
||
467 | [new SessionMiddleware( |
||
468 | new Sha256(), |
||
469 | 'foo', |
||
470 | 'foo', |
||
471 | SetCookie::create(SessionMiddleware::DEFAULT_COOKIE), |
||
472 | new Parser(), |
||
473 | 100, |
||
474 | new SystemClock() |
||
475 | )], |
||
476 | [SessionMiddleware::fromSymmetricKeyDefaults('not relevant', 100)], |
||
477 | [SessionMiddleware::fromAsymmetricKeyDefaults( |
||
478 | file_get_contents(__DIR__ . '/../../keys/private_key.pem'), |
||
479 | file_get_contents(__DIR__ . '/../../keys/public_key.pem'), |
||
480 | 200 |
||
481 | )], |
||
482 | ]; |
||
483 | } |
||
484 | |||
485 | /** |
||
486 | * @group #46 |
||
487 | */ |
||
488 | public function testFromSymmetricKeyDefaultsWillHaveADefaultSessionPath() : void |
||
489 | { |
||
490 | self::assertSame( |
||
491 | '/', |
||
492 | $this |
||
493 | ->getCookie( |
||
494 | SessionMiddleware::fromSymmetricKeyDefaults('not relevant', 100) |
||
495 | ->process(new ServerRequest(), $this->writingMiddleware()) |
||
496 | ) |
||
497 | ->getPath() |
||
498 | ); |
||
499 | } |
||
500 | |||
501 | /** |
||
502 | * @group #46 |
||
503 | * |
||
504 | * @throws \InvalidArgumentException |
||
505 | * @throws \OutOfBoundsException |
||
506 | */ |
||
507 | public function testFromAsymmetricKeyDefaultsWillHaveADefaultSessionPath() : void |
||
508 | { |
||
509 | self::assertSame( |
||
510 | '/', |
||
511 | $this |
||
512 | ->getCookie( |
||
513 | SessionMiddleware |
||
514 | ::fromAsymmetricKeyDefaults( |
||
515 | file_get_contents(__DIR__ . '/../../keys/private_key.pem'), |
||
516 | file_get_contents(__DIR__ . '/../../keys/public_key.pem'), |
||
517 | 200 |
||
518 | ) |
||
519 | ->process(new ServerRequest(), $this->writingMiddleware()) |
||
520 | ) |
||
521 | ->getPath() |
||
522 | ); |
||
523 | } |
||
524 | |||
525 | private function ensureSameResponse( |
||
526 | SessionMiddleware $middleware, |
||
527 | ServerRequestInterface $request, |
||
528 | RequestHandlerInterface $next = null |
||
529 | ) : ResponseInterface { |
||
530 | $initialResponse = new Response(); |
||
531 | |||
532 | $handleRequest = $this->createMock(RequestHandlerInterface::class); |
||
533 | |||
534 | if ($next) { |
||
535 | // capturing `$initialResponse` from the `$next` handler |
||
536 | $handleRequest |
||
537 | ->expects(self::once()) |
||
538 | ->method('handle') |
||
539 | ->willReturnCallback(function (ServerRequestInterface $serverRequest) use ($next, & $initialResponse) { |
||
540 | $initialResponse = $next->handle($serverRequest); |
||
541 | |||
542 | return $initialResponse; |
||
543 | }); |
||
544 | } else { |
||
545 | $handleRequest |
||
546 | ->expects(self::once()) |
||
547 | ->method('handle') |
||
548 | ->willReturn($initialResponse); |
||
549 | } |
||
550 | |||
551 | $response = $middleware->process($request, $handleRequest); |
||
552 | |||
553 | self::assertSame($initialResponse, $response); |
||
554 | |||
555 | return $response; |
||
556 | } |
||
557 | |||
558 | private function ensureClearsSessionCookie( |
||
559 | SessionMiddleware $middleware, |
||
560 | ServerRequestInterface $request, |
||
561 | RequestHandlerInterface $next |
||
562 | ) : ResponseInterface { |
||
563 | $response = $middleware->process($request, $next); |
||
564 | |||
565 | $cookie = $this->getCookie($response); |
||
566 | |||
567 | self::assertLessThan((new \DateTime('-29 day'))->getTimestamp(), $cookie->getExpires()); |
||
568 | self::assertEmpty($cookie->getValue()); |
||
569 | |||
570 | return $response; |
||
571 | } |
||
572 | |||
573 | /** |
||
574 | * @param SessionMiddleware $middleware |
||
575 | * @param \DateTime $issuedAt |
||
576 | * @param \DateTime $expiration |
||
577 | * |
||
578 | * @return string |
||
579 | */ |
||
580 | private function createToken(SessionMiddleware $middleware, \DateTime $issuedAt, \DateTime $expiration) : string |
||
589 | |||
590 | private function emptyValidationMiddleware() : RequestHandlerInterface |
||
591 | { |
||
592 | return $this->fakeDelegate( |
||
593 | function (ServerRequestInterface $request) { |
||
594 | /* @var $session SessionInterface */ |
||
595 | $session = $request->getAttribute(SessionMiddleware::SESSION_ATTRIBUTE); |
||
596 | |||
597 | self::assertInstanceOf(SessionInterface::class, $session); |
||
598 | self::assertTrue($session->isEmpty()); |
||
599 | |||
600 | return new Response(); |
||
601 | } |
||
602 | ); |
||
603 | } |
||
604 | |||
605 | private function writingMiddleware(string $value = 'bar') : RequestHandlerInterface |
||
617 | |||
618 | private function fakeDelegate(callable $callback) : RequestHandlerInterface |
||
630 | |||
631 | /** |
||
632 | * @param ResponseInterface $response |
||
633 | * |
||
634 | * @return \Zend\Diactoros\ServerRequest |
||
635 | */ |
||
636 | private function requestWithResponseCookies(ResponseInterface $response) : ServerRequestInterface |
||
642 | |||
643 | /** |
||
644 | * @param ResponseInterface $response |
||
645 | * |
||
646 | * @return SetCookie |
||
647 | */ |
||
648 | private function getCookie(ResponseInterface $response, string $name = SessionMiddleware::DEFAULT_COOKIE) : SetCookie |
||
652 | |||
653 | /** |
||
654 | * @param SessionMiddleware $middleware |
||
655 | * |
||
656 | * @return Signer |
||
657 | */ |
||
658 | private function getSigner(SessionMiddleware $middleware) : Signer |
||
662 | |||
663 | /** |
||
664 | * @param SessionMiddleware $middleware |
||
665 | * |
||
666 | * @return string |
||
667 | */ |
||
668 | private function getSignatureKey(SessionMiddleware $middleware) : string |
||
672 | |||
673 | /** |
||
674 | * @param object $object |
||
675 | * @param string $name |
||
676 | * |
||
677 | * @return mixed |
||
678 | */ |
||
679 | private function getPropertyValue($object, string $name) |
||
686 | } |
||
687 |
It seems like the method you are trying to call exists only in some of the possible types.
Let’s take a look at an example:
Available Fixes
Add an additional type-check:
Only allow a single type to be passed if the variable comes from a parameter: