CORS
Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 17 z 20.
Strona pod adresem https://shop.example.com wywołuje Twoje API za pomocą fetch, a przeglądarka blokuje odpowiedź. Przeglądarki pozwalają stronie odczytywać odpowiedzi tylko z jej własnego originu (schematu, hosta i portu), chyba że serwer zezwoli na dostęp z innych originów za pomocą nagłówków CORS. Przed żądaniem PUT, PATCH, DELETE lub żądaniem z treścią JSON przeglądarka najpierw wysyła żądanie OPTIONS, czyli preflight, a właściwe żądanie wysyła tylko wtedy, gdy odpowiedź na preflight na to zezwala.
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");Oprogramowanie pośredniczące CORS odpowiada na żądanie preflight kodem 204 oraz listą dozwolonych metod i nagłówków, a także dodaje Access-Control-Allow-Origin do każdej odpowiedzi dla tego originu. Inny origin nie otrzyma nagłówków CORS, więc jego przeglądarka zablokuje żądanie. CORS egzekwują tylko przeglądarki: curl i pasek żądań ignorują te zasady.
Wyzwanie
ŚredniAplikacja tablicy w innej witrynie, https://board.example.com, chce wywoływać Twoje API z przeglądarki. Zezwól na to pochodzenie i tylko na nie.
- W pliku
Program.cs, przedbuilder.Build(), dodaj za pomocąbuilder.Services.AddCorsregułę CORS o nazwieboard. Zezwala ona na pochodzeniehttps://board.example.com, metody GET, POST, PUT, PATCH i DELETE oraz nagłówekContent-Type. - Tablica wyświetla "page 1 of 3" na podstawie
X-Total-Count. Strona z innego pochodzenia może odczytać tylko kilka standardowych nagłówków odpowiedzi, chyba że serwer udostępnia ich więcej, więc dodaj do reguły.WithExposedHeaders("X-Total-Count"). - Po
app.UseStatusCodePages();włącz regułę za pomocąapp.UseCors("board");
Zapytanie preflight z tablicy otrzymuje odpowiedź 204 z tymi nagłówkami:
Access-Control-Allow-Origin: https://board.example.com
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Content-TypeWypróbuj: naciśnij „Uruchom”, wybierz OPTIONS, ścieżkę /api/tasks/2 i dodaj nagłówki Origin: https://board.example.com oraz Access-Control-Request-Method: DELETE. Wyślij: odpowiedź 204, puste ciało i powyższe nagłówki na karcie Headers. Wyślij GET /api/tasks z tym samym Origin: odpowiedź 200 z nagłówkami Access-Control-Allow-Origin i Access-Control-Expose-Headers. W przypadku Origin: https://evil.example.com odpowiedź nie zawiera nagłówków CORS.
Spróbuj swoich sił
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);
Ta lekcja zawiera krótki quiz. Zacznij lekcję, żeby na niego odpowiedzieć i śledzić swoje postępy.