PyJWT Python (Comment ça marche : Un guide pour les développeurs)

Installation

Pour installer PyJWT, vous pouvez utiliser pip :

pip install pyjwt

pip install pyjwt

Pour un support cryptographique supplémentaire, vous pouvez l'installer avec l'option crypto :

pip install pyjwt[crypto]

pip install pyjwt[crypto]

Utilisation de base

Voici un simple exemple d'utilisation de PyJWT dans une implémentation 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)

Dans cet exemple, nous créons un JWT en codant une charge utile avec une clé secrète en utilisant l'algorithme HS256. Nous décodons alors le jeton pour récupérer la charge utile originale.

Sortie

Cas d'utilisation

1. Authentification : Les JWTs sont couramment utilisés pour l'authentification dans les applications Web. Après qu'un utilisateur se soit connecté, le serveur génère un JWT et renvoie le jeton signé au client. Le client peut vérifier l'identité de l'utilisateur à l'aide de ce jeton et inclure le jeton dans les requêtes suivantes.
2. Échange d'informations : Les parties peuvent transmettre des informations de manière sécurisée en utilisant des JWTs. La charge utile peut inclure n'importe quelle donnée ; la signature du jeton garantit son intégrité.

Principales Caractéristiques d'IronPDF

Prérequis IronPDF

1. IronPDF utilise .NET 6.0 comme technologie sous-jacente. Assurez-vous donc que l'exécution .NET 6.0 est installée sur votre système.
2. Python 3.0+ : Vous devez avoir installé la version 3 de Python ou une version ultérieure.
3. Pip : Installez le programme d'installation de package Python pip pour installer le package IronPDF.

Pour commencer, créons un fichier Python à la racine du projet pour ajouter nos scripts. Dans cet exemple, nous utilisons Visual Studio Code comme éditeur de code.

Ouvrez Visual Studio Code et créez un fichier, pyjwtDemo.py.

Installez la bibliothèque IronPDF :

pip install ironpdf
pip install pyjwt

pip install ironpdf
pip install pyjwt

Puis, ajoutez le code ci-dessous pour démontrer l'utilisation des packages Python IronPDF et 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")

Explication du code

Ce code montre comment utiliser la bibliothèque jwt (JSON Web Token) avec IronPDF pour créer un document PDF incluant des exemples de codage et de décodage de JWTs.

Voici un aperçu des fonctions de chaque composant de code :

1. Imports et configuration de la clé de licence:

   Importe la bibliothèque jwt pour la fonctionnalité de jeton Web JSON et ChromePdfRenderer d'IronPDF pour la génération de PDFs. Définit la clé de licence pour IronPDF pour activer ses fonctionnalités.

2. Configuration du contenu HTML :

   Initialise la variable content avec un balisage HTML à inclure dans le document PDF, illustrant les différentes étapes du processus.

3. Codage d'un JWT :

   • Définit un dictionnaire de charge utile contenant les données à coder dans le JWT (payload).
   • Spécifie une clé secrète (secret) pour signer le JWT avec l'algorithme HMAC utilisant SHA-256 (HS256).
   • Génère un jeton JWT en utilisant la fonction jwt.encode() et l'imprime.

4. Décodage d'un JWT :

   • Ajoute un balisage HTML pour démontrer le décodage du JWT.
   • Décode le JWT précédemment généré (token) en utilisant la fonction jwt.decode() avec la même clé secrète et algorithme utilisés pour le codage.

5. Génération de PDF :

   • Il utilise ChromePdfRenderer pour rendre la chaîne HTML content dans un document PDF et sauvegarde le fichier PDF généré sous le nom "Demo-pyjwt.pdf."

Cette configuration permet la création d'un document PDF qui montre l'utilisation de JWTs avec IronPDF pour générer des PDFs de qualité professionnelle.

Sortie

PDF