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
|
<?php
declare(strict_types=1);
namespace Lcobucci\JWT\Tests\Token;
use DateTimeImmutable;
use Lcobucci\JWT\Encoder;
use Lcobucci\JWT\Encoding\MicrosecondBasedDateConversion;
use Lcobucci\JWT\Signer;
use Lcobucci\JWT\Signer\Key\InMemory;
use Lcobucci\JWT\Token\Builder;
use Lcobucci\JWT\Token\DataSet;
use Lcobucci\JWT\Token\Plain;
use Lcobucci\JWT\Token\RegisteredClaimGiven;
use Lcobucci\JWT\Token\RegisteredClaims;
use Lcobucci\JWT\Token\Signature;
use PHPUnit\Framework\Attributes as PHPUnit;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use SplObjectStorage;
#[PHPUnit\CoversClass(Builder::class)]
#[PHPUnit\CoversClass(RegisteredClaimGiven::class)]
#[PHPUnit\UsesClass(MicrosecondBasedDateConversion::class)]
#[PHPUnit\UsesClass(InMemory::class)]
#[PHPUnit\UsesClass(Plain::class)]
#[PHPUnit\UsesClass(Signature::class)]
#[PHPUnit\UsesClass(DataSet::class)]
final class BuilderTest extends TestCase
{
private Encoder&MockObject $encoder;
private Signer&MockObject $signer;
#[PHPUnit\Before]
public function initializeDependencies(): void
{
$this->encoder = $this->createMock(Encoder::class);
$this->signer = $this->createMock(Signer::class);
$this->signer->method('algorithmId')->willReturn('RS256');
}
#[PHPUnit\Test]
public function withClaimShouldRaiseExceptionWhenTryingToConfigureARegisteredClaim(): void
{
$builder = Builder::new($this->encoder, new MicrosecondBasedDateConversion());
$this->expectException(RegisteredClaimGiven::class);
$this->expectExceptionMessage(
'Builder#withClaim() is meant to be used for non-registered claims, '
. 'check the documentation on how to set claim "iss"',
);
$builder->withClaim(RegisteredClaims::ISSUER, 'me');
}
#[PHPUnit\Test]
public function getTokenShouldReturnACompletelyConfigureToken(): void
{
$issuedAt = new DateTimeImmutable('@1487285080');
$notBefore = DateTimeImmutable::createFromFormat('U.u', '1487285080.000123');
$expiration = DateTimeImmutable::createFromFormat('U.u', '1487285080.123456');
self::assertInstanceOf(DateTimeImmutable::class, $notBefore);
self::assertInstanceOf(DateTimeImmutable::class, $expiration);
$this->encoder->expects(self::exactly(2))
->method('jsonEncode')
->willReturnOnConsecutiveCalls('1', '2');
$this->encoder->expects(self::exactly(3))
->method('base64UrlEncode')
->willReturnArgument(0);
$this->signer->expects($this->once())
->method('sign')
->with('1.2')
->willReturn('3');
$builder = Builder::new($this->encoder, new MicrosecondBasedDateConversion());
$token = $builder->identifiedBy('123456')
->issuedBy('https://issuer.com')
->issuedAt($issuedAt)
->canOnlyBeUsedAfter($notBefore)
->expiresAt($expiration)
->relatedTo('subject')
->permittedFor('test1')
->permittedFor('test2')
->permittedFor('test2') // should not be added since it's duplicated
->withClaim('test', 123)
->withHeader('userId', 2)
->getToken($this->signer, InMemory::plainText('123'));
self::assertSame('JWT', $token->headers()->get('typ'));
self::assertSame('RS256', $token->headers()->get('alg'));
self::assertSame(2, $token->headers()->get('userId'));
self::assertSame(123, $token->claims()->get('test'));
self::assertSame($issuedAt, $token->claims()->get(RegisteredClaims::ISSUED_AT));
self::assertSame($notBefore, $token->claims()->get(RegisteredClaims::NOT_BEFORE));
self::assertSame($expiration, $token->claims()->get(RegisteredClaims::EXPIRATION_TIME));
self::assertSame('123456', $token->claims()->get(RegisteredClaims::ID));
self::assertSame('https://issuer.com', $token->claims()->get(RegisteredClaims::ISSUER));
self::assertSame('subject', $token->claims()->get(RegisteredClaims::SUBJECT));
self::assertSame(['test1', 'test2'], $token->claims()->get(RegisteredClaims::AUDIENCE));
self::assertSame('3', $token->signature()->toString());
}
#[PHPUnit\Test]
public function immutability(): void
{
$map = new SplObjectStorage();
$builder = Builder::new($this->encoder, new MicrosecondBasedDateConversion());
$map[$builder] = true;
$builder = $builder->identifiedBy('123456');
$map[$builder] = true;
$builder = $builder->issuedBy('https://issuer.com');
$map[$builder] = true;
$builder = $builder->issuedAt(new DateTimeImmutable());
$map[$builder] = true;
$builder = $builder->canOnlyBeUsedAfter(new DateTimeImmutable());
$map[$builder] = true;
$builder = $builder->expiresAt(new DateTimeImmutable());
$map[$builder] = true;
$builder = $builder->relatedTo('subject');
$map[$builder] = true;
$builder = $builder->permittedFor('test1');
$map[$builder] = true;
$builder = $builder->withClaim('test', 123);
$map[$builder] = true;
$builder = $builder->withHeader('userId', 2);
$map[$builder] = true;
self::assertCount(10, $map);
}
}
|