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
|
<?php
declare(strict_types=1);
namespace Lcobucci\JWT\Tests;
use DateTimeImmutable;
use Lcobucci\Clock\FrozenClock;
use Lcobucci\JWT\Configuration;
use Lcobucci\JWT\Encoding;
use Lcobucci\JWT\Signer\Key\InMemory;
use Lcobucci\JWT\SodiumBase64Polyfill;
use Lcobucci\JWT\Token;
use Lcobucci\JWT\Validation\Constraint;
use Lcobucci\JWT\Validation\Constraint\IdentifiedBy;
use Lcobucci\JWT\Validation\Constraint\IssuedBy;
use Lcobucci\JWT\Validation\Constraint\LooseValidAt;
use Lcobucci\JWT\Validation\Constraint\PermittedFor;
use Lcobucci\JWT\Validation\ConstraintViolation;
use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
use Lcobucci\JWT\Validation\Validator;
use PHPUnit\Framework\Attributes as PHPUnit;
use PHPUnit\Framework\TestCase;
use function assert;
#[PHPUnit\CoversClass(Configuration::class)]
#[PHPUnit\CoversClass(Encoding\JoseEncoder::class)]
#[PHPUnit\CoversClass(Encoding\ChainedFormatter::class)]
#[PHPUnit\CoversClass(Encoding\MicrosecondBasedDateConversion::class)]
#[PHPUnit\CoversClass(Encoding\UnifyAudience::class)]
#[PHPUnit\CoversClass(Token\Builder::class)]
#[PHPUnit\CoversClass(Token\Parser::class)]
#[PHPUnit\CoversClass(Token\Plain::class)]
#[PHPUnit\CoversClass(Token\DataSet::class)]
#[PHPUnit\CoversClass(Token\Signature::class)]
#[PHPUnit\CoversClass(InMemory::class)]
#[PHPUnit\CoversClass(SodiumBase64Polyfill::class)]
#[PHPUnit\CoversClass(ConstraintViolation::class)]
#[PHPUnit\CoversClass(RequiredConstraintsViolated::class)]
#[PHPUnit\CoversClass(Validator::class)]
#[PHPUnit\CoversClass(IssuedBy::class)]
#[PHPUnit\CoversClass(PermittedFor::class)]
#[PHPUnit\CoversClass(IdentifiedBy::class)]
#[PHPUnit\CoversClass(LooseValidAt::class)]
class UnsignedTokenTest extends TestCase
{
public const CURRENT_TIME = 100000;
private Configuration $config;
#[PHPUnit\Before]
public function createConfiguration(): void
{
$this->config = Configuration::forSymmetricSigner(
new KeyDumpSigner(),
InMemory::plainText('private'),
);
}
#[PHPUnit\Test]
public function builderCanGenerateAToken(): Token
{
$user = ['name' => 'testing', 'email' => 'testing@abc.com'];
$builder = $this->config->builder();
$expiration = new DateTimeImmutable('@' . (self::CURRENT_TIME + 3000));
$token = $builder->identifiedBy('1')
->permittedFor('https://client.abc.com')
->issuedBy('https://api.abc.com')
->expiresAt($expiration)
->withClaim('user', $user)
->getToken($this->config->signer(), $this->config->signingKey());
self::assertEquals(new Token\Signature('private', 'cHJpdmF0ZQ'), $token->signature());
self::assertEquals(['https://client.abc.com'], $token->claims()->get(Token\RegisteredClaims::AUDIENCE));
self::assertSame('https://api.abc.com', $token->claims()->get(Token\RegisteredClaims::ISSUER));
self::assertEquals($expiration, $token->claims()->get(Token\RegisteredClaims::EXPIRATION_TIME));
self::assertEquals($user, $token->claims()->get('user'));
return $token;
}
#[PHPUnit\Test]
#[PHPUnit\Depends('builderCanGenerateAToken')]
public function parserCanReadAToken(Token $generated): void
{
$read = $this->config->parser()->parse($generated->toString());
assert($read instanceof Token\Plain);
self::assertEquals($generated, $read);
self::assertSame('testing', $read->claims()->get('user')['name']);
}
#[PHPUnit\Test]
#[PHPUnit\Depends('builderCanGenerateAToken')]
public function tokenValidationShouldPassWhenEverythingIsFine(Token $generated): void
{
$clock = new FrozenClock(new DateTimeImmutable('@' . self::CURRENT_TIME));
$constraints = [
new IdentifiedBy('1'),
new PermittedFor('https://client.abc.com'),
new IssuedBy('https://issuer.abc.com', 'https://api.abc.com'),
new LooseValidAt($clock),
];
self::assertTrue($this->config->validator()->validate($generated, ...$constraints));
}
#[PHPUnit\Test]
#[PHPUnit\Depends('builderCanGenerateAToken')]
public function tokenValidationShouldAllowCustomConstraint(Token $generated): void
{
self::assertTrue($this->config->validator()->validate($generated, $this->validUserConstraint()));
}
#[PHPUnit\Test]
#[PHPUnit\Depends('builderCanGenerateAToken')]
public function tokenAssertionShouldRaiseExceptionWhenOneOfTheConstraintsFails(Token $generated): void
{
$constraints = [
new IdentifiedBy('1'),
new IssuedBy('https://issuer.abc.com'),
];
$this->expectException(RequiredConstraintsViolated::class);
$this->expectExceptionMessage('The token violates some mandatory constraints');
$this->config->validator()->assert($generated, ...$constraints);
}
private function validUserConstraint(): Constraint
{
return new class () implements Constraint
{
public function assert(Token $token): void
{
if (! $token instanceof Token\Plain) {
throw new ConstraintViolation();
}
$claims = $token->claims();
if (! $claims->has('user')) {
throw new ConstraintViolation();
}
$name = $claims->get('user')['name'] ?? '';
$email = $claims->get('user')['email'] ?? '';
if ($name === '' || $email === '') {
throw new ConstraintViolation();
}
}
};
}
}
|