add HasClaim constraint

docs/validating-tokens.md

@@ -90,5 +90,6 @@ This library provides the following constraints:
 * `Lcobucci\JWT\Validation\Constraint\StrictValidAt`: verifies presence and validity of the claims `iat`, `nbf`, and `exp` (supports leeway configuration)
 * `Lcobucci\JWT\Validation\Constraint\LooseValidAt`: verifies the claims `iat`, `nbf`, and `exp`, when present (supports leeway configuration)
 * `Lcobucci\JWT\Validation\Constraint\HasClaimWithValue`: verifies that a **custom claim** has the expected value (not recommended when comparing cryptographic hashes)
+* `Lcobucci\JWT\Validation\Constraint\HasClaim`: verifies that a claim is present
 
 You may also create your [own validation constraints](extending-the-library.md#validation-constraints).

src/Validation/Constraint/HasClaim.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+namespace Lcobucci\JWT\Validation\Constraint;
+
+use Lcobucci\JWT\Token;
+use Lcobucci\JWT\UnencryptedToken;
+use Lcobucci\JWT\Validation\Constraint;
+use Lcobucci\JWT\Validation\ConstraintViolation;
+
+final class HasClaim implements Constraint
+{
+ /** @param non-empty-string $claim */
+ public function __construct(private readonly string $claim)
+ {
+ }
+
+ public function assert(Token $token): void
+ {
+ if (! $token instanceof UnencryptedToken) {
+ throw ConstraintViolation::error('You should pass a plain token', $this);
+ }
+
+ $claims = $token->claims();
+
+ if (! $claims->has($this->claim)) {
+ throw ConstraintViolation::error('The token does not have the claim "' . $this->claim . '"', $this);
+ }
+ }
+}

tests/Validation/Constraint/HasClaimTest.php

@@ -0,0 +1,49 @@
+<?php
+declare(strict_types=1);
+
+namespace Lcobucci\JWT\Tests\Validation\Constraint;
+
+use Lcobucci\JWT\Token;
+use Lcobucci\JWT\Validation\Constraint\HasClaim;
+use Lcobucci\JWT\Validation\ConstraintViolation;
+
+/**
+ * @covers \Lcobucci\JWT\Validation\ConstraintViolation
+ * @covers \Lcobucci\JWT\Validation\Constraint\HasClaim
+ *
+ * @uses \Lcobucci\JWT\Token\DataSet
+ * @uses \Lcobucci\JWT\Token\Plain
+ * @uses \Lcobucci\JWT\Token\Signature
+ */
+final class HasClaimTest extends ConstraintTestCase
+{
+ /** @test */
+ public function assertShouldRaiseExceptionWhenClaimIsNotSet(): void
+ {
+ $this->expectException(ConstraintViolation::class);
+ $this->expectExceptionMessage('The token does not have the claim "claimId"');
+
+ $constraint = new HasClaim('claimId');
+ $constraint->assert($this->buildToken());
+ }
+
+ /** @test */
+ public function assertShouldRaiseExceptionWhenTokenIsNotAPlainToken(): void
+ {
+ $this->expectException(ConstraintViolation::class);
+ $this->expectExceptionMessage('You should pass a plain token');
+
+ $constraint = new HasClaim('claimId');
+ $constraint->assert($this->createMock(Token::class));
+ }
+
+ /** @test */
+ public function assertShouldNotRaiseExceptionWhenClaimMatches(): void
+ {
+ $token = $this->buildToken(['claimId' => 'claimValue']);
+ $constraint = new HasClaim('claimId');
+
+ $constraint->assert($token);
+ $this->addToAssertionCount(1);
+ }
+}