Resolvendo problemas de assinatura de JWT no Symfony: solução de problemas de configuração

Configurando Symfony para autenticação JWT

Configuração do Symfony com YAML

# config/packages/lexik_jwt_authentication.yaml
lexik_jwt_authentication:
    secret_key: '%env(resolve:JWT_SECRET_KEY)%'
    public_key: '%env(resolve:JWT_PUBLIC_KEY)%'
    pass_phrase: '%env(JWT_PASSPHRASE)%'
    token_ttl: 3600

# config/packages/security.yaml
security:
    encoders:
        App\Entity\User:
            algorithm: auto

    providers:
        app_user_provider:
            entity:
                class: App\Entity\User
                property: email

    firewalls:
        login:
            pattern:  ^/api/login
            stateless: true
            json_login:
                check_path: /api/login_check
                success_handler: lexik_jwt_authentication.handler.authentication_success
                failure_handler: lexik_jwt_authentication.handler.authentication_failure
                username_path: email
                password_path: password

        api:
            pattern:   ^/api
            stateless: true
            provider: app_user_provider
            jwt: ~

    access_control:
        - { path: ^/api/login, roles: PUBLIC_ACCESS }
        - { path: ^/api,       roles: IS_AUTHENTICATED_FULLY }

Gerando chaves JWT para Symfony

Script de linha de comando para OpenSSL

openssl genrsa -out config/jwt/private.pem -aes256 4096
openssl rsa -pubout -in config/jwt/private.pem -out config/jwt/public.pem

Configuração de entidade Symfony para JWT

Script PHP para entidade de usuário

<?php
namespace App\Entity;

use App\Repository\UserRepository;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
use Symfony\Component\Security\Core\User\UserInterface;

#[ORM\Entity(repositoryClass: UserRepository::class)]
#[ORM\UniqueConstraint(name: 'UNIQ_IDENTIFIER_EMAIL', fields: ['email'])]
class User implements UserInterface, PasswordAuthenticatedUserInterface
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\Column(length: 180)]
    private ?string $email = null;

    #[ORM\Column]
    private array $roles = [];

    #[ORM\Column]
    private ?string $password = null;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getEmail(): ?string
    {
        return $this->email;
    }

    public function setEmail(string $email): static
    {
        $this->email = $email;
        return $this;
    }

    public function getUserIdentifier(): string
    {
        return (string) $this->email;
    }

    public function getRoles(): array
    {
        $roles = $this->roles;
        $roles[] = 'ROLE_USER';
        return array_unique($roles);
    }

    public function setRoles(array $roles): static
    {
        $this->roles = $roles;
        return $this;
    }

    public function getPassword(): string
    {
        return $this->password;
    }

    public function setPassword(string $password): static
    {
        $this->password = $password;
        return $this;
    }

    public function eraseCredentials(): void
    {
        // Clear temporary, sensitive data
    }
}

Perguntas comuns sobre configuração JWT no Symfony

1. Como faço para gerar as chaves RSA para JWT?
2. Use o comando openssl genrsa -out config/jwt/private.pem -aes256 4096 para gerar uma chave privada e openssl rsa -pubout -in config/jwt/private.pem -out config/jwt/public.pem para extrair a chave pública.
3. O que devo fazer se receber um erro de permissão?
4. Certifique-se de que os arquivos-chave tenham as permissões corretas. Use o comando chmod 600 config/jwt/private.pem para definir as permissões adequadas.
5. Por que minha configuração JWT não funciona apesar de seguir a documentação?
6. Verifique novamente suas variáveis ​​ambientais no .env arquivo e certifique-se de que correspondam às chaves e à senha usadas durante a geração da chave.
7. Como posso testar se minha configuração JWT está correta?
8. Execute o comando php bin/console lexik:jwt:generate-token test@test.com para gerar um token e verificar se ele foi criado sem erros.
9. Que papel desempenha o pass_phrase jogar na configuração JWT?
10. O pass_phrase é usado para criptografar a chave privada. Ele deve ser configurado corretamente em suas variáveis ​​de ambiente para que o Symfony possa usá-lo durante a criação do token.
11. Como configuro o caminho de login JSON?
12. No security.yaml, colocou o check_path ao seu endpoint de login, normalmente /api/login_check.
13. O que faz o token_ttl parâmetro fazer?
14. O token_ttl O parâmetro define o tempo de vida do JWT, determinando por quanto tempo o token permanece válido.
15. Por que preciso de uma chave secreta e de uma chave pública?
16. A chave secreta é usada para assinar o JWT, enquanto a chave pública é usada para verificar a assinatura do token.
17. Como posso garantir que o lexik/jwt-authentication-bundle está instalado corretamente?
18. Verifique o seu bundles.php arquivo para garantir que o pacote esteja registrado e que todos os arquivos de configuração estejam carregados corretamente.
19. Qual é a função dos firewalls na autenticação JWT?
20. Firewalls em security.yaml defina como diferentes partes do seu aplicativo lidam com autenticação e autorização, garantindo que apenas usuários autenticados possam acessar determinados terminais.