CORS
Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 17 sur 20.
Une page sur https://shop.example.com appelle votre API avec fetch, et le navigateur bloque la réponse. Les navigateurs permettent à une page de lire les réponses provenant uniquement de sa propre origine (schéma, hôte et port), sauf si le serveur en autorise d’autres avec des en-têtes CORS. Avant une requête PUT, PATCH, DELETE ou contenant un corps JSON, le navigateur envoie d’abord une requête OPTIONS, le précontrôle, et n’envoie la requête réelle que si la réponse l’autorise.
builder.Services.AddCors(options =>
options.AddPolicy("shop", policy => policy
.WithOrigins("https://shop.example.com")
.WithMethods("GET", "POST")
.WithHeaders("Content-Type")));
var app = builder.Build();
app.UseCors("shop");Le middleware CORS répond au précontrôle avec le code 204 et les méthodes et en-têtes autorisés, et ajoute Access-Control-Allow-Origin à chaque réponse destinée à cette origine. Une autre origine ne reçoit aucun en-tête CORS, donc son navigateur bloque la réponse. Seuls les navigateurs appliquent CORS : curl et la barre de requête l’ignorent.
Défi
MoyenUne application de tableau sur un autre site, https://board.example.com, veut appeler votre API depuis le navigateur. Autorisez cette origine, et uniquement celle-ci.
- Dans
Program.cs, avantbuilder.Build(), ajoutez une stratégie CORS nomméeboardavecbuilder.Services.AddCors. Elle autorise l’originehttps://board.example.com, les méthodes GET, POST, PUT, PATCH et DELETE, ainsi que l’en-têteContent-Type. - Le tableau affiche "page 1 of 3" à partir de
X-Total-Count. Une page provenant d’une autre origine ne peut lire que quelques en-têtes de réponse standard, sauf si le serveur en expose davantage. Ajoutez donc.WithExposedHeaders("X-Total-Count")à la stratégie. - Après
app.UseStatusCodePages();, activez la stratégie avecapp.UseCors("board");
Une requête préliminaire du tableau reçoit une réponse 204 avec ces en-têtes :
Access-Control-Allow-Origin: https://board.example.com
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Content-TypeEssayez : appuyez sur Exécuter, choisissez OPTIONS, indiquez le chemin /api/tasks/2 et ajoutez les en-têtes Origin: https://board.example.com et Access-Control-Request-Method: DELETE. Envoyez la requête : réponse 204, corps vide et en-têtes ci-dessus dans l’onglet En-têtes. Envoyez GET /api/tasks avec la même Origin : réponse 200 avec Access-Control-Allow-Origin et Access-Control-Expose-Headers. Avec Origin: https://evil.example.com, la réponse ne contient aucun en-tête CORS.
Essayez vous-même
using System.ComponentModel.DataAnnotations;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();
var tasks = new List<TaskItem>
{
new(1, "Write the project brief", false, 1),
new(2, "Book the meeting room", true, 3),
new(3, "Send the invoice", false),
};
var nextId = 4;
bool TitleTaken(string title, int exceptId) =>
tasks.Any(t => t.Id != exceptId && string.Equals(t.Title, title, StringComparison.OrdinalIgnoreCase));
app.MapGet("/api/tasks", (bool? done, string? search, int? priority, string? sort, HttpResponse response, int page = 1, int pageSize = 10) =>
{
var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "id" && sort != "title" && sort != "priority")
errors["sort"] = ["Sort by id, title or priority."];
if (priority is < 1 or > 3)
errors["priority"] = ["Priority is 1 to 3."];
if (page < 1)
errors["page"] = ["Page starts at 1."];
if (pageSize < 1 || pageSize > 50)
errors["pageSize"] = ["Page size is 1 to 50."];
if (errors.Count > 0) return Results.ValidationProblem(errors);
IEnumerable<TaskItem> result = tasks;
if (done is not null) result = result.Where(t => t.Done == done);
if (!string.IsNullOrWhiteSpace(search))
result = result.Where(t => t.Title.Contains(search, StringComparison.OrdinalIgnoreCase));
if (priority is not null) result = result.Where(t => t.Priority == priority);
if (sort == "title") result = result.OrderBy(t => t.Title);
if (sort == "priority") result = result.OrderBy(t => t.Priority);
var matching = result.ToList();
response.Headers["X-Total-Count"] = matching.Count.ToString();
return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});
app.MapGet("/api/tasks/{id:int}", (int id) =>
{
var task = tasks.Find(t => t.Id == id);
return task is null ? Results.NotFound() : Results.Ok(task);
});
app.MapPost("/api/tasks", (TaskInput input) =>
{
var errors = Validation.Errors(input);
if (errors is not null) return Results.ValidationProblem(errors);
if (TitleTaken(input.Title, 0))
return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
var task = new TaskItem(nextId++, input.Title, input.Done, input.Priority);
tasks.Add(task);
return Results.Created($"/api/tasks/{task.Id}", task);
});
app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
var errors = Validation.Errors(input);
if (errors is not null) return Results.ValidationProblem(errors);
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
if (TitleTaken(input.Title, id))
return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
tasks[index] = new TaskItem(id, input.Title, input.Done, input.Priority);
return Results.Ok(tasks[index]);
});
app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
var errors = Validation.Errors(patch);
if (errors is not null) return Results.ValidationProblem(errors);
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
if (patch.Title is not null && TitleTaken(patch.Title, id))
return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
var task = tasks[index];
tasks[index] = task with
{
Title = patch.Title ?? task.Title,
Done = patch.Done ?? task.Done,
Priority = patch.Priority ?? task.Priority,
};
return Results.Ok(tasks[index]);
});
app.MapDelete("/api/tasks/{id:int}", (int id) =>
{
var removed = tasks.RemoveAll(t => t.Id == id);
return removed == 0 ? Results.NotFound() : Results.NoContent();
});
app.MapDelete("/api/tasks", (bool? done) =>
{
if (done != true)
{
return Results.ValidationProblem(new Dictionary<string, string[]>
{
["done"] = ["Add ?done=true to delete the done tasks."],
});
}
tasks.RemoveAll(t => t.Done);
return Results.NoContent();
});
app.Run();
record TaskItem(int Id, string Title, bool Done, int Priority = 2);
record TaskInput(
[property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
bool Done,
[property: Range(1, 3)] int Priority = 2);
record TaskPatch(string? Title, bool? Done, [property: Range(1, 3)] int? Priority);
Cette leçon comprend un petit quiz. Commencez la leçon pour y répondre et suivre votre progression.