CORS
Teil des Abschnitts REST-APIs der ASP.NET Core-Journey von Coddy. Lektion 17 von 20.
Eine Seite auf https://shop.example.com ruft deine API mit fetch auf, und der Browser blockiert die Antwort. Browser erlauben einer Seite, Antworten nur von ihrem eigenen Origin (Schema, Host und Port) zu lesen, sofern der Server anderen nicht mit CORS-Headern Zugriff gewährt. Vor einem PUT, einem PATCH, einem DELETE oder einem JSON-Body sendet der Browser zunächst eine OPTIONS-Anfrage, den Preflight, und sendet die eigentliche Anfrage nur, wenn die Antwort sie erlaubt.
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");Die CORS-Middleware beantwortet den Preflight mit 204 sowie den erlaubten Methoden und Headern und fügt Access-Control-Allow-Origin jeder Antwort für diesen Origin hinzu. Ein anderer Origin erhält keine CORS-Header, sodass sein Browser die Antwort blockiert. Nur Browser setzen CORS durch: curl und die Anfrageleiste ignorieren es.
Aufgabe
Mittel- Füge in
Program.csvorbuilder.Build()mitbuilder.Services.AddCorseine CORS-Richtlinie namensboardhinzu. Sie erlaubt den Ursprunghttps://board.example.com, die Methoden GET, POST, PUT, PATCH und DELETE sowie den HeaderContent-Type. - Das Board zeigt „page 1 of 3“ anhand von
X-Total-Countan. Eine Seite von einem anderen Ursprung kann nur einige wenige standardmäßige Antwort-Header lesen, sofern der Server nicht weitere freigibt. Füge der Richtlinie deshalb.WithExposedHeaders("X-Total-Count")hinzu. - Aktiviere die Richtlinie nach
app.UseStatusCodePages();mitapp.UseCors("board");
Eine Preflight-Anfrage vom Board erhält die Antwort 204 mit diesen Headern:
Access-Control-Allow-Origin: https://board.example.com
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Content-TypeProbiere es aus: Drücke „Ausführen“, wähle OPTIONS und den Pfad /api/tasks/2 aus und füge die Header Origin: https://board.example.com und Access-Control-Request-Method: DELETE hinzu. Drücke „Senden“: Die Antwort lautet 204, hat einen leeren Body und enthält die oben genannten Header im Tab „Headers“. Sende GET /api/tasks mit demselben Origin: Die Antwort lautet 200 und enthält Access-Control-Allow-Origin und Access-Control-Expose-Headers. Bei Origin: https://evil.example.com enthält die Antwort keine CORS-Header.
Probier es selbst
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);
Diese Lektion enthält ein kurzes Quiz. Starte die Lektion, um es zu beantworten und deinen Fortschritt zu speichern.