BookStack Code Mirror - bookstack/blob - app/Access/Oidc/OidcIdToken.php

   1 <?php
   2
   3 namespace BookStack\Access\Oidc;
   4
   5 class OidcIdToken implements ProvidesClaims
   6 {
   7     protected array $header;
   8     protected array $payload;
   9     protected string $signature;
  10     protected string $issuer;
  11     protected array $tokenParts = [];
  12
  13     /**
  14      * @var array[]|string[]
  15      */
  16     protected array $keys;
  17
  18     public function __construct(string $token, string $issuer, array $keys)
  19     {
  20         $this->keys = $keys;
  21         $this->issuer = $issuer;
  22         $this->parse($token);
  23     }
  24
  25     /**
  26      * Parse the token content into its components.
  27      */
  28     protected function parse(string $token): void
  29     {
  30         $this->tokenParts = explode('.', $token);
  31         $this->header = $this->parseEncodedTokenPart($this->tokenParts[0]);
  32         $this->payload = $this->parseEncodedTokenPart($this->tokenParts[1] ?? '');
  33         $this->signature = $this->base64UrlDecode($this->tokenParts[2] ?? '') ?: '';
  34     }
  35
  36     /**
  37      * Parse a Base64-JSON encoded token part.
  38      * Returns the data as a key-value array or empty array upon error.
  39      */
  40     protected function parseEncodedTokenPart(string $part): array
  41     {
  42         $json = $this->base64UrlDecode($part) ?: '{}';
  43         $decoded = json_decode($json, true);
  44
  45         return is_array($decoded) ? $decoded : [];
  46     }
  47
  48     /**
  49      * Base64URL decode. Needs some character conversions to be compatible
  50      * with PHP's default base64 handling.
  51      */
  52     protected function base64UrlDecode(string $encoded): string
  53     {
  54         return base64_decode(strtr($encoded, '-_', '+/'));
  55     }
  56
  57     /**
  58      * Validate all possible parts of the id token.
  59      *
  60      * @throws OidcInvalidTokenException
  61      */
  62     public function validate(string $clientId): bool
  63     {
  64         $this->validateTokenStructure();
  65         $this->validateTokenSignature();
  66         $this->validateTokenClaims($clientId);
  67
  68         return true;
  69     }
  70
  71     /**
  72      * Fetch a specific claim from this token.
  73      * Returns null if it is null or does not exist.
  74      */
  75     public function getClaim(string $claim): mixed
  76     {
  77         return $this->payload[$claim] ?? null;
  78     }
  79
  80     /**
  81      * Get all returned claims within the token.
  82      */
  83     public function getAllClaims(): array
  84     {
  85         return $this->payload;
  86     }
  87
  88     /**
  89      * Replace the existing claim data of this token with that provided.
  90      */
  91     public function replaceClaims(array $claims): void
  92     {
  93         $this->payload = $claims;
  94     }
  95
  96     /**
  97      * Validate the structure of the given token and ensure we have the required pieces.
  98      * As per https://datatracker.ietf.org/doc/html/rfc7519#section-7.2.
  99      *
 100      * @throws OidcInvalidTokenException
 101      */
 102     protected function validateTokenStructure(): void
 103     {
 104         foreach (['header', 'payload'] as $prop) {
 105             if (empty($this->$prop) || !is_array($this->$prop)) {
 106                 throw new OidcInvalidTokenException("Could not parse out a valid {$prop} within the provided token");
 107             }
 108         }
 109
 110         if (empty($this->signature) || !is_string($this->signature)) {
 111             throw new OidcInvalidTokenException('Could not parse out a valid signature within the provided token');
 112         }
 113     }
 114
 115     /**
 116      * Validate the signature of the given token and ensure it validates against the provided key.
 117      *
 118      * @throws OidcInvalidTokenException
 119      */
 120     protected function validateTokenSignature(): void
 121     {
 122         if ($this->header['alg'] !== 'RS256') {
 123             throw new OidcInvalidTokenException("Only RS256 signature validation is supported. Token reports using {$this->header['alg']}");
 124         }
 125
 126         $parsedKeys = array_map(function ($key) {
 127             try {
 128                 return new OidcJwtSigningKey($key);
 129             } catch (OidcInvalidKeyException $e) {
 130                 throw new OidcInvalidTokenException('Failed to read signing key with error: ' . $e->getMessage());
 131             }
 132         }, $this->keys);
 133
 134         $parsedKeys = array_filter($parsedKeys);
 135
 136         $contentToSign = $this->tokenParts[0] . '.' . $this->tokenParts[1];
 137         /** @var OidcJwtSigningKey $parsedKey */
 138         foreach ($parsedKeys as $parsedKey) {
 139             if ($parsedKey->verify($contentToSign, $this->signature)) {
 140                 return;
 141             }
 142         }
 143
 144         throw new OidcInvalidTokenException('Token signature could not be validated using the provided keys');
 145     }
 146
 147     /**
 148      * Validate the claims of the token.
 149      * As per https://openid.net/specs/openid-connect-basic-1_0.html#IDTokenValidation.
 150      *
 151      * @throws OidcInvalidTokenException
 152      */
 153     protected function validateTokenClaims(string $clientId): void
 154     {
 155         // 1. The Issuer Identifier for the OpenID Provider (which is typically obtained during Discovery)
 156         // MUST exactly match the value of the iss (issuer) Claim.
 157         if (empty($this->payload['iss']) || $this->issuer !== $this->payload['iss']) {
 158             throw new OidcInvalidTokenException('Missing or non-matching token issuer value');
 159         }
 160
 161         // 2. The Client MUST validate that the aud (audience) Claim contains its client_id value registered
 162         // at the Issuer identified by the iss (issuer) Claim as an audience. The ID Token MUST be rejected
 163         // if the ID Token does not list the Client as a valid audience, or if it contains additional
 164         // audiences not trusted by the Client.
 165         if (empty($this->payload['aud'])) {
 166             throw new OidcInvalidTokenException('Missing token audience value');
 167         }
 168
 169         $aud = is_string($this->payload['aud']) ? [$this->payload['aud']] : $this->payload['aud'];
 170         if (count($aud) !== 1) {
 171             throw new OidcInvalidTokenException('Token audience value has ' . count($aud) . ' values, Expected 1');
 172         }
 173
 174         if ($aud[0] !== $clientId) {
 175             throw new OidcInvalidTokenException('Token audience value did not match the expected client_id');
 176         }
 177
 178         // 3. If the ID Token contains multiple audiences, the Client SHOULD verify that an azp Claim is present.
 179         // NOTE: Addressed by enforcing a count of 1 above.
 180
 181         // 4. If an azp (authorized party) Claim is present, the Client SHOULD verify that its client_id
 182         // is the Claim Value.
 183         if (isset($this->payload['azp']) && $this->payload['azp'] !== $clientId) {
 184             throw new OidcInvalidTokenException('Token authorized party exists but does not match the expected client_id');
 185         }
 186
 187         // 5. The current time MUST be before the time represented by the exp Claim
 188         // (possibly allowing for some small leeway to account for clock skew).
 189         if (empty($this->payload['exp'])) {
 190             throw new OidcInvalidTokenException('Missing token expiration time value');
 191         }
 192
 193         $skewSeconds = 120;
 194         $now = time();
 195         if ($now >= (intval($this->payload['exp']) + $skewSeconds)) {
 196             throw new OidcInvalidTokenException('Token has expired');
 197         }
 198
 199         // 6. The iat Claim can be used to reject tokens that were issued too far away from the current time,
 200         // limiting the amount of time that nonces need to be stored to prevent attacks.
 201         // The acceptable range is Client specific.
 202         if (empty($this->payload['iat'])) {
 203             throw new OidcInvalidTokenException('Missing token issued at time value');
 204         }
 205
 206         $dayAgo = time() - 86400;
 207         $iat = intval($this->payload['iat']);
 208         if ($iat > ($now + $skewSeconds) || $iat < $dayAgo) {
 209             throw new OidcInvalidTokenException('Token issue at time is not recent or is invalid');
 210         }
 211
 212         // 7. If the acr Claim was requested, the Client SHOULD check that the asserted Claim Value is appropriate.
 213         // The meaning and processing of acr Claim Values is out of scope for this document.
 214         // NOTE: Not used for our case here. acr is not requested.
 215
 216         // 8. When a max_age request is made, the Client SHOULD check the auth_time Claim value and request
 217         // re-authentication if it determines too much time has elapsed since the last End-User authentication.
 218         // NOTE: Not used for our case here. A max_age request is not made.
 219
 220         // Custom: Ensure the "sub" (Subject) Claim exists and has a value.
 221         if (empty($this->payload['sub'])) {
 222             throw new OidcInvalidTokenException('Missing token subject value');
 223         }
 224     }
 225 }