Menu
CoddyTech

CORS

Часть раздела REST API путешествия по ASP.NET Core на Coddy. Урок 17 из 20.

Страница на https://shop.example.com вызывает ваш API с помощью fetch, и браузер блокирует ответ. Браузеры позволяют странице читать ответы только от своего источника (схемы, хоста и порта), если сервер не разрешает другие источники с помощью заголовков CORS. Перед отправкой PUT, PATCH, DELETE или тела JSON браузер сначала отправляет запрос OPTIONS — предварительный запрос — и отправляет настоящий запрос, только если ответ разрешает это.

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 отвечает на предварительный запрос кодом 204 и списком разрешённых методов и заголовков, а также добавляет Access-Control-Allow-Origin к каждому ответу для этого источника. Для другого источника заголовки CORS не добавляются, поэтому браузер блокирует его запрос. CORS проверяют только браузеры: curl и панель запросов игнорируют это ограничение.

challenge icon

Задание

Средне

Приложение-доска на другом сайте, https://board.example.com, хочет обращаться к вашему API из браузера. Разрешите этот источник и только его.

  1. В Program.cs, перед builder.Build(), добавьте политику CORS с именем board с помощью builder.Services.AddCors. Она разрешает источник https://board.example.com, методы GET, POST, PUT, PATCH и DELETE, а также заголовок Content-Type.
  2. На доске отображается «страница 1 из 3» на основе X-Total-Count. Страница с другого источника может читать лишь несколько стандартных заголовков ответа, если сервер не предоставляет другие, поэтому добавьте в политику .WithExposedHeaders("X-Total-Count").
  3. После 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, пустое тело и указанные выше заголовки на вкладке «Заголовки». Отправьте 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);
quiz iconПроверьте себя

В этом уроке есть небольшой тест. Начните урок, чтобы ответить на вопросы и сохранить прогресс.

Все уроки раздела REST API