Files
panel/app/Services/Nodes/NodeJWTService.php
Dane Everitt 7ffcd63631 Attach a scope(s) to JWTs created by the panel (#5636)
Necessary for proper token identification on Wings.
2026-05-23 11:15:36 -07:00

112 lines
3.0 KiB
PHP

<?php
namespace Pterodactyl\Services\Nodes;
use Carbon\CarbonImmutable;
use Illuminate\Support\Str;
use Pterodactyl\Models\Node;
use Pterodactyl\Models\User;
use Webmozart\Assert\Assert;
use Pterodactyl\Enum\JwtScope;
use Lcobucci\JWT\Configuration;
use Lcobucci\JWT\UnencryptedToken;
use Lcobucci\JWT\Signer\Hmac\Sha256;
use Lcobucci\JWT\Signer\Key\InMemory;
use Pterodactyl\Extensions\Lcobucci\JWT\Encoding\TimestampDates;
class NodeJWTService
{
private array $claims = [];
private array $scopes;
private ?User $user = null;
private \DateTimeImmutable $expiresAt;
private ?string $subject = null;
/**
* Set the claims to include in this JWT.
*/
public function setClaims(array $claims): self
{
$this->claims = $claims;
return $this;
}
public function setScopes(JwtScope ...$scopes): self
{
$this->scopes = $scopes;
return $this;
}
/**
* Attaches a user to the JWT being created and will automatically inject the
* "user_uuid" key into the final claims array with the user's UUID.
*/
public function setUser(User $user): self
{
$this->user = $user;
return $this;
}
public function setExpiresAt(\DateTimeImmutable $date): self
{
$this->expiresAt = $date;
return $this;
}
public function setSubject(string $subject): self
{
$this->subject = $subject;
return $this;
}
/**
* Generate a new JWT for a given node.
*/
public function handle(Node $node, ?string $identifiedBy): UnencryptedToken
{
$identifier = hash('sha256', $identifiedBy);
$config = Configuration::forSymmetricSigner(new Sha256(), InMemory::plainText($node->getDecryptedKey()));
$builder = $config->builder(new TimestampDates())
->issuedBy(config('app.url'))
->permittedFor($node->getConnectionAddress())
->identifiedBy($identifier)
->withHeader('jti', $identifier)
->issuedAt(CarbonImmutable::now())
->canOnlyBeUsedAfter(CarbonImmutable::now()->subMinutes(5));
if (isset($this->expiresAt)) {
$builder = $builder->expiresAt($this->expiresAt);
}
if (!empty($this->subject)) {
$builder = $builder->relatedTo($this->subject)->withHeader('sub', $this->subject);
}
foreach ($this->claims as $key => $value) {
$builder = $builder->withClaim($key, $value);
}
Assert::notEmpty($this->scopes, 'Cannot generate a JWT without providing at least one scope.');
$builder = $builder->withClaim('scope', implode(' ', array_map(fn ($scope) => $scope->value, $this->scopes)));
if (!is_null($this->user)) {
$builder = $builder->withClaim('user_uuid', $this->user->uuid);
}
return $builder
->withClaim('unique_id', Str::random())
->getToken($config->signer(), $config->signingKey());
}
}