CORS
חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 17 מתוך 20.
דף בכתובת https://shop.example.com קורא ל-API שלך באמצעות fetch, והדפדפן חוסם את התשובה. דפדפנים מאפשרים לדף לקרוא תשובות רק מה-origin שלו (סכמה, מארח ופורט), אלא אם השרת מאפשר לאחרים באמצעות כותרות CORS. לפני בקשת PUT, PATCH, DELETE או בקשה עם גוף JSON, הדפדפן שולח תחילה בקשת OPTIONS, שנקראת preflight, ושולח את הבקשה האמיתית רק אם התשובה מתירה זאת.
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");תוכנת הביניים של CORS משיבה לבקשת ה-preflight עם קוד 204 ועם השיטות והכותרות המותרות, ומוסיפה את Access-Control-Allow-Origin לכל תשובה עבור אותו origin. Origin אחר לא מקבל כותרות CORS, ולכן הדפדפן שלו חוסם את הבקשה. רק דפדפנים אוכפים את CORS: curl ושורת הבקשות מתעלמים ממנו.
אתגר
בינוניאפליקציית לוח באתר אחר, https://board.example.com, רוצה לקרוא ל-API שלך מהדפדפן. אפשר את המקור הזה, ורק אותו.
- ב-
Program.cs, לפניbuilder.Build(), הוסף מדיניות CORS בשםboardבאמצעותbuilder.Services.AddCors. היא מאפשרת את המקורhttps://board.example.com, את השיטות GET, POST, PUT, PATCH ו-DELETE, ואת הכותרתContent-Type. - הלוח מציג "page 1 of 3" מתוך
X-Total-Count. דף ממקור אחר יכול לקרוא רק כמה כותרות תגובה סטנדרטיות, אלא אם השרת חושף כותרות נוספות, לכן הוסף למדיניות.WithExposedHeaders("X-Total-Count"). - אחרי
app.UseStatusCodePages();, הפעל את המדיניות באמצעותapp.UseCors("board");
בקשת קדם-הפעלה מהלוח מקבלת תשובה 204 עם הכותרות האלה:
Access-Control-Allow-Origin: https://board.example.com
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Content-Typeנסה זאת: לחץ על הרצה, בחר OPTIONS, נתיב /api/tasks/2, והוסף את הכותרות Origin: https://board.example.com ו-Access-Control-Request-Method: DELETE. שלח: 204, גוף ריק והכותרות שלמעלה בכרטיסייה Headers. שלח GET /api/tasks עם אותו Origin: התשובה תהיה 200 עם Access-Control-Allow-Origin ו-Access-Control-Expose-Headers. עם Origin: https://evil.example.com, התשובה אינה כוללת כותרות CORS.
נסו בעצמכם
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);
השיעור הזה כולל חידון קצר. התחילו את השיעור כדי לענות עליו ולעקוב אחרי ההתקדמות.