Ajoutez l’authentification JWT d’Auth0 à une API Web ASP.NET Core avec des points de terminaison protégés
Ce guide de démarrage rapide est actuellement en bêta. N’hésitez pas à nous faire part de vos commentaires!
Utiliser l’IA pour intégrer Auth0
Si vous utilisez un assistant IA de codage comme Claude Code, Cursor ou GitHub Copilot, vous pouvez ajouter automatiquement l’authentification Auth0 en quelques minutes à l’aide des agent skills.Installer :
Add Auth0 JWT authentication to my ASP.NET Core Web API
Votre assistant IA créera automatiquement votre API Auth0, récupérera les identifiants, installera le SDK d’authentification API Auth0 pour ASP.NET Core, configurera l’authentification JWT Bearer et mettra en œuvre des points de terminaison d’API protégés. Documentation complète sur les agent skills →
Prérequis : Avant de commencer, assurez-vous d’avoir installé ce qui suit :
Ce guide de démarrage rapide montre comment ajouter l’authentification JWT d’Auth0 à une API Web ASP.NET Core. Vous créerez une API sécurisée avec des points de terminaison protégés à l’aide du SDK API ASP.NET Core d’Auth0.
1
Créer un nouveau projet
Créez un nouveau projet d’API web ASP.NET Core pour ce guide de démarrage rapide
Ensuite, vous devez créer une nouvelle API sur votre tenant Auth0 et ajouter la configuration à votre projet.Vous pouvez effectuer cette opération automatiquement en exécutant une commande CLI ou manuellement via le tableau de bord :
interface de ligne de commande
Tableau de bord
Exécutez la commande shell suivante à la racine du projet pour créer une API Auth0 et mettre à jour votre fichier appsettings.json :
Identifier : https://my-api (cela devient votre Audience)
Signing Algorithm : RS256
Cliquez sur Create
Remplacez YOUR_AUTH0_DOMAIN dans appsettings.json par votre Domain à partir de l’onglet Test (p. ex., your-tenant.auth0.com)
Remplacez YOUR_AUTH0_API_IDENTIFIER dans appsettings.json par votre Identifier (p. ex., https://my-api)
Votre Domain ne doit pas inclure https:// — utilisez seulement le nom de domaine (p. ex., your-tenant.auth0.com).L’Audience (identifiant de l’API) est un identifiant unique pour votre API et peut être n’importe quel URI valide. Elle n’a pas besoin d’être une URL accessible publiquement.
4
Configurer l’authentification
Remplacez l’intégralité du contenu de Program.cs par le code suivant :
Créer des points de terminaison publics et protégés
Ajoutez des points de terminaison pour tester l’authentification. Ajoutez le code suivant à Program.cs avant app.Run() :
Program.cs
// Point de terminaison public - aucune authentification requiseapp.MapGet("/api/public", () => Results.Ok(new { Message = "This endpoint is public" })) .WithName("GetPublic");// Point de terminaison protégé - authentification requiseapp.MapGet("/api/private", () => Results.Ok(new { Message = "This endpoint requires authentication" })) .RequireAuthorization() .WithName("GetPrivate");
6
Exécutez votre API
dotnet run
Votre API fonctionne maintenant à l’adresse https://localhost:7190 (ou à une URL semblable - vérifiez la sortie de la console pour connaître l’URL exacte).
Point de contrôleVous devriez maintenant avoir une API protégée par Auth0 entièrement fonctionnelle, accessible sur votre localhost
Pour obtenir YOUR_CLIENT_ID et YOUR_CLIENT_SECRET, créez une application Machine-to-Machine dans le tableau de bord Auth0 et autorisez-la à accéder à votre API.
2. Testez le point de terminaison public (devrait renvoyer 200 OK) :
curl https://localhost:7190/api/public
3. Testez le point de terminaison protégé sans authentification (devrait renvoyer 401 Unauthorized) :
curl https://localhost:7190/api/private
4. Appelez le point de terminaison protégé avec le jeton :
Utiliser des points de terminaison basés sur des contrôleurs
Pour les API plus volumineuses, utilisez des contrôleurs plutôt que des points de terminaison d’API minimaux.1. Ajoutez la prise en charge des contrôleurs :
2. Créez un contrôleur :Créez Controllers/MessagesController.cs :
Controllers/MessagesController.cs
using Microsoft.AspNetCore.Authorization;using Microsoft.AspNetCore.Mvc;namespace Auth0Api.Controllers;[ApiController][Route("api/[controller]")]public class MessagesController : ControllerBase{ [HttpGet] public IActionResult GetPublic() { return Ok(new { Message = "This endpoint is public" }); } [Authorize] [HttpGet("private")] public IActionResult GetPrivate() { var userId = User.FindFirst("sub")?.Value; return Ok(new { Message = "This endpoint is protected", UserId = userId }); } [Authorize(Policy = "read:messages")] [HttpGet("messages")] public IActionResult GetMessages() { return Ok(new { Messages = new[] { "Message 1", "Message 2" } }); }}
Protéger des routes à l’aide d’une autorisation basée sur les portées
Protégez les points de terminaison en fonction de portées précises dans le jeton d’accès.1. Définissez des portées dans votre API Auth0 :Dans le tableau de bord Auth0 → APIs → Your API → Permissions, ajoutez des portées :
DPoP (Demonstration of Proof-of-Possession) associe les jetons d’accès à des clés cryptographiques, ce qui empêche le vol de jetons et les attaques par rejeu.Activer la prise en charge de DPoP :
Program.cs
builder.Services.AddAuth0ApiAuthentication(options =>{ options.Domain = builder.Configuration["Auth0:Domain"]; options.JwtBearerOptions = new JwtBearerOptions { Audience = builder.Configuration["Auth0:Audience"] };}).WithDPoP(); // Activer DPoP avec les paramètres par défaut
Modes DPoP :Accepter à la fois les jetons DPoP et Bearer (par défaut) :
using Auth0.AspNetCore.Authentication.Api.DPoP;.WithDPoP(dpopOptions =>{ dpopOptions.Mode = DPoPModes.Allowed;});
Accepter uniquement les jetons DPoP et rejeter les jetons Bearer :
using Auth0.AspNetCore.Authentication.Api.DPoP;.WithDPoP(dpopOptions =>{ dpopOptions.Mode = DPoPModes.Required;});
Configurer les paramètres de validation temporelle :
.WithDPoP(dpopOptions =>{ dpopOptions.Mode = DPoPModes.Allowed; dpopOptions.IatOffset = 300; // Autoriser une preuve DPoP datant d’au plus 5 minutes dpopOptions.Leeway = 30; // Tolérance de 30 secondes pour le décalage de l’horloge});
Problème : La validation du jeton échoue en raison d’une incompatibilité de l’audience.Solution : Assurez-vous que Audience dans appsettings.json correspond exactement à l’identifiant de votre API Auth0. La revendication d’audience du jeton doit correspondre à cette valeur.
{ "Auth0": { "Audience": "https://my-api" // Doit correspondre à l’identifiant de l’API Auth0 }}
401 Non autorisé - Émetteur non valide
Problème : La validation du jeton échoue en raison d’une erreur liée à l’émetteur.Solution : Vérifiez que votre domaine est correct et qu’il n’inclut pas https://. La bibliothèque construit automatiquement l’autorité sous la forme https://{Domain}.
{ "Auth0": { "Domain": "your-tenant.auth0.com" // Sans https:// }}
Valeurs de configuration introuvables
Problème :ArgumentNullException: Value cannot be null. (Parameter 'Domain') ou un message semblable.Solution : Assurez-vous que appsettings.json contient la section Auth0 avec les valeurs Domain et Audience. Vérifiez aussi que la configuration est bien lue :
builder.Services.AddAuth0ApiAuthentication(options =>{ options.Domain = builder.Configuration["Auth0:Domain"] ?? throw new InvalidOperationException("Auth0:Domain is required"); options.JwtBearerOptions = new JwtBearerOptions { Audience = builder.Configuration["Auth0:Audience"] ?? throw new InvalidOperationException("Auth0:Audience is required") };});
Erreurs de certificat HTTPS en développement
Problème : Des erreurs de certificat SSL/TLS surviennent lors de l’exécution en local.Solution : Faites approuver le certificat de développement :
Problème : L’authentification ne fonctionne pas malgré une configuration correcte.Solution : Assurez-vous que le middleware est dans le bon ordre. UseAuthentication() doit être appelé avant UseAuthorization() :
app.UseAuthentication(); // Doit être avant UseAuthorizationapp.UseAuthorization();app.MapControllers();
Les portées ne fonctionnent pas dans les politiques d’autorisation
Problème : Les politiques d’autorisation basées sur les portées échouent systématiquement.Solution : Assurez-vous que votre jeton d’accès comprend les portées requises. Lorsque vous demandez un jeton, précisez les portées :
curl --request POST \ --url https://YOUR_DOMAIN/oauth/token \ --data '{"client_id":"...","client_secret":"...","audience":"...","grant_type":"client_credentials","scope":"read:messages write:messages"}'
Vérifiez aussi que les portées sont définies dans les paramètres de votre API Auth0 (tableau de bord Auth0 → APIs → Your API → Permissions).
Un exemple d’application complet illustrant toutes les fonctionnalités est disponible dans le dépôt du SDK.
Application de démonstration
Comprend des points de terminaison publics et protégés, la prise en charge de DPoP, l’intégration de Swagger UI et une collection Postman
Clonez et exécutez :
git clone https://github.com/auth0/aspnetcore-api.gitcd aspnetcore-api/Auth0.AspNetCore.Authentication.Api.Playground# Mettez à jour appsettings.json avec votre configuration Auth0dotnet run