PyJWT Python (Cómo Funciona: Una Guía para Desarrolladores)

Instalación

Para instalar PyJWT, puedes usar pip:

pip install pyjwt

pip install pyjwt

Para soporte criptográfico adicional, puedes instalarlo con la opción crypto:

pip install pyjwt[crypto]

pip install pyjwt[crypto]

Uso básico

Aquí hay un ejemplo simple de cómo usar PyJWT en una implementación de 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)

En este ejemplo, creamos un JWT codificando un payload con una clave secreta utilizando el algoritmo HS256. Luego decodificamos el token para recuperar el payload original.

Resultado

Casos de uso

1. Autenticación: los JWTs se utilizan comúnmente para la autenticación en aplicaciones web. Después de que un usuario inicia sesión, el servidor genera un JWT y devuelve el token firmado al cliente. El cliente puede verificar la identidad del usuario usando este token e incluir el token en solicitudes posteriores.
2. Intercambio de Información: Las partes pueden transmitir información de forma segura usando JWTs. El payload puede incluir cualquier dato; la firma del token asegura su integridad.

Características principales de IronPDF

Requisitos previos para IronPDF

1. IronPDF usa .NET 6.0 como su tecnología subyacente. Por lo tanto, asegúrate de que el runtime .NET 6.0 esté instalado en tu sistema.
2. Python 3.0+: Necesita tener instalada la versión 3 o posterior de Python.
3. Pip: Instala el instalador de paquetes de Python pip para instalar el paquete IronPDF.

Para empezar, creemos un archivo Python en la raíz del proyecto para agregar nuestros scripts. Para este ejemplo, utilizamos Visual Studio Code como editor de código.

Abre Visual Studio Code y crea un archivo, pyjwtDemo.py.

Instale la biblioteca de IronPDF:

pip install ironpdf
pip install pyjwt

pip install ironpdf
pip install pyjwt

Luego agrega el siguiente código para demostrar el uso de los paquetes de Python IronPDF y 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")

Explicación del código

Este fragmento de código demuestra cómo usar la biblioteca jwt (JSON Web Token) junto con IronPDF para crear un documento PDF que incluye ejemplos de codificación y decodificación de JWTs.

A continuación se presenta un resumen de funciones de cada componente.

1. Importaciones y Configuración de Clave de Licencia:

   Importa la biblioteca jwt para funcionalidades de JSON Web Token y ChromePdfRenderer de IronPDF para la generación de PDF. Establece la clave de licencia para IronPDF para habilitar sus características.

2. Configuración de Contenido HTML:

   Inicializa la variable content con marcado HTML para incluir en el documento PDF, ilustrando diferentes pasos en el proceso.

3. Codificación de un JWT:

   • Define un diccionario payload que contiene datos para codificar en el JWT (payload).
   • Especifica una clave secreta (secret) para firmar el JWT con el algoritmo HMAC usando SHA-256 (HS256).
   • Genera un token JWT utilizando la función jwt.encode() y lo imprime.

4. Decodificación de un JWT:

   • Agrega marcado HTML para demostrar la decodificación de JWT.
   • Decodifica el JWT previamente generado (token) utilizando la función jwt.decode() con la misma clave y algoritmo usado para codificar.

5. Generación de PDF:

   • Utiliza ChromePdfRenderer para renderizar la cadena HTML content en un documento PDF y guarda el archivo PDF generado como "Demo-pyjwt.pdf".

Esta configuración permite la creación de un documento PDF que muestra el uso de JWTs con IronPDF para generar PDFs de calidad profesional.

Resultado

PDF