PyJWT em Python (Como funciona: um guia para desenvolvedores)

Instalação

Para instalar o PyJWT , você pode usar o pip:

pip install pyjwt

pip install pyjwt

Para suporte criptográfico adicional, você pode instalá-lo com a opção crypto:

pip install pyjwt[crypto]

pip install pyjwt[crypto]

Uso básico

Aqui está um exemplo simples de como usar PyJWT em uma implementação em Python:

import jwt

# Encoding a JWT
payload = {"Message": "IronPDF is an Awesome PDF library"}
secret = "your-256-bit-secret"
# Create the JWT token with a secret key using HS256 algorithm
token = jwt.encode(payload, secret, algorithm="HS256")
print(token)

# Decoding a JWT
# Decode the JWT token to retrieve the original payload
decoded_payload = jwt.decode(token, secret, algorithms=["HS256"])
print(decoded_payload)

import jwt

# Encoding a JWT
payload = {"Message": "IronPDF is an Awesome PDF library"}
secret = "your-256-bit-secret"
# Create the JWT token with a secret key using HS256 algorithm
token = jwt.encode(payload, secret, algorithm="HS256")
print(token)

# Decoding a JWT
# Decode the JWT token to retrieve the original payload
decoded_payload = jwt.decode(token, secret, algorithms=["HS256"])
print(decoded_payload)

Neste exemplo, criamos um JWT codificando uma carga útil com uma chave secreta usando o algoritmo HS256. Em seguida, decodificamos o token para recuperar a carga útil original.

Saída

Casos de uso

1. Autenticação: Os JWTs são comumente usados ​​para autenticação em aplicações web. Após o usuário efetuar o login, o servidor gera um JWT e retorna o token assinado para o cliente. O cliente pode verificar a identidade do usuário usando esse token e incluí-lo em solicitações subsequentes.
2. Troca de informações: As partes podem transmitir informações com segurança usando JWTs. A carga útil pode incluir quaisquer dados; A assinatura do token garante sua integridade.

Principais características do IronPDF

Pré-requisitos do IronPDF

1. O IronPDF utiliza o .NET 6.0 como tecnologia subjacente. Portanto, certifique-se de que o ambiente de execução .NET 6.0 esteja instalado em seu sistema.
2. Python 3.0+: Você precisa ter o Python versão 3 ou posterior instalado.
3. Pip: Instale o instalador de pacotes Python pip para instalar o pacote IronPDF .

Para começar, vamos criar um arquivo Python na raiz do projeto para adicionar nossos scripts. Neste exemplo, usaremos o Visual Studio Code como editor de código.

Abra o Visual Studio Code e crie um arquivo, pyjwtDemo.py.

Instale a biblioteca IronPDF :

pip install ironpdf
pip install pyjwt

pip install ironpdf
pip install pyjwt

Em seguida, adicione o código abaixo para demonstrar o uso dos pacotes Python IronPDF e PyJWT :

import jwt
from ironpdf import ChromePdfRenderer, License

# Apply your license key
License.LicenseKey = "your-license-key"

# Initialize HTML content to be converted into PDF
content = "<h1>Awesome IronPDF with PyJWT</h1>"
content += "<h2>Encoding a JWT</h2>"

# Encoding a JWT
payload = {"Message": "IronPDF is an Awesome PDF library"}
secret = "your-256-bit-secret"  # Secret key for signing
token = jwt.encode(payload, secret, algorithm="HS256")
print(token)  # Print the generated JWT

# Append details to the HTML content
content += f"<p>Message: {payload['Message']}</p>"
content += f"<p>Secret: {secret}</p>"
content += f"<p>Generated Token: {token}</p>"

# Decoding a JWT
content += "<h2>Decoding a JWT</h2>"
decoded_payload = jwt.decode(token, secret, algorithms=["HS256"])
print(decoded_payload)  # Print the decoded payload

# Append decoded payload details to the HTML content
content += f"<p>Decoded Token: {decoded_payload}</p>"

# Generate PDF using IronPDF
renderer = ChromePdfRenderer()
pdf = renderer.RenderHtmlAsPdf(content)

# Export PDF to a file
pdf.SaveAs("Demo-pyjwt.pdf")

import jwt
from ironpdf import ChromePdfRenderer, License

# Apply your license key
License.LicenseKey = "your-license-key"

# Initialize HTML content to be converted into PDF
content = "<h1>Awesome IronPDF with PyJWT</h1>"
content += "<h2>Encoding a JWT</h2>"

# Encoding a JWT
payload = {"Message": "IronPDF is an Awesome PDF library"}
secret = "your-256-bit-secret"  # Secret key for signing
token = jwt.encode(payload, secret, algorithm="HS256")
print(token)  # Print the generated JWT

# Append details to the HTML content
content += f"<p>Message: {payload['Message']}</p>"
content += f"<p>Secret: {secret}</p>"
content += f"<p>Generated Token: {token}</p>"

# Decoding a JWT
content += "<h2>Decoding a JWT</h2>"
decoded_payload = jwt.decode(token, secret, algorithms=["HS256"])
print(decoded_payload)  # Print the decoded payload

# Append decoded payload details to the HTML content
content += f"<p>Decoded Token: {decoded_payload}</p>"

# Generate PDF using IronPDF
renderer = ChromePdfRenderer()
pdf = renderer.RenderHtmlAsPdf(content)

# Export PDF to a file
pdf.SaveAs("Demo-pyjwt.pdf")

Explicação do código

Este trecho de código demonstra como usar a biblioteca jwt (JSON Web Token) juntamente com o IronPDF para criar um documento PDF que inclui exemplos de codificação e decodificação de JWTs.

A seguir, apresentamos uma visão geral das funções de cada componente de código:

1. Importação e configuração da chave de licença:

   Importa a biblioteca jwt para funcionalidade de JSON Web Token e a biblioteca ChromePdfRenderer do IronPDF para geração de PDF. Define a chave de licença do IronPDF para ativar seus recursos.

2. Configuração do conteúdo HTML:

   Inicializa a variável content com a marcação HTML a ser incluída no documento PDF, ilustrando diferentes etapas do processo.

3. Codificando um JWT:

   • Define um dicionário de payload contendo dados a serem codificados no JWT (payload).
   • Especifica uma chave secreta (secret) para assinar o JWT com o algoritmo HMAC usando SHA-256 (HS256).
   • Gera um token JWT usando a função jwt.encode() e o imprime.

4. Decodificando um JWT:

   • Adiciona marcação HTML para demonstrar a decodificação de JWT.
   • Decodifica o JWT gerado anteriormente (token) usando a função jwt.decode() com o mesmo segredo e algoritmo usados ​​para codificação.

5. Geração de PDF:

   • Ele usa ChromePdfRenderer para renderizar a string HTML content em um documento PDF e salva o arquivo PDF gerado como "Demo-pyjwt.pdf".

Essa configuração permite a criação de um documento PDF que demonstra o uso de JWTs com o IronPDF para gerar PDFs de qualidade profissional.

Saída

PDF