Kurz: Implementace chráněného koncového bodu do rozhraní API

V tomto kurzu se dozvíte, jak chránit koncový bod rozhraní API přidáním ověřovacích prvků do zdrojového kódu. Ochrana koncového bodu rozhraní API zajišťuje, aby přístup byl povolený jenom autorizovaným uživatelům. Můžete otestovat rozhraní API s neověřeným požadavkem, abyste zajistili, že vaše rozhraní API omezuje přístup k neoprávněným uživatelům. Platforma Microsoft Identity Platform poskytuje způsob, jak chránit koncové body rozhraní API pomocí balíčku NuGet Microsoft.Identity.Web . V tomto článku, vy;

• Implementace ověřovacích prvků do zdrojového kódu
• Přidání informací o počasí pro zobrazení rozhraní API
• Otestování rozhraní API s neověřeným požadavkem GET

Požadavky

• Dokončení požadavků a kroků v kurzu: Vytvoření a konfigurace projektu ASP.NET Core pro ověřování

Implementace autorizace

1. Otevřete soubor Program.cs a nahraďte jeho obsah následujícím fragmentem kódu:

   using Microsoft.AspNetCore.Authentication.JwtBearer;
   using Microsoft.AspNetCore.Authorization;
   using Microsoft.Identity.Web;
   
   var builder = WebApplication.CreateBuilder(args);
   builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
           .AddMicrosoftIdentityWebApi(options =>
           {
               builder.Configuration.Bind("AzureAd", options);
               options.TokenValidationParameters.NameClaimType = "name";
           }, options => { builder.Configuration.Bind("AzureAd", options); });
   
       builder.Services.AddAuthorization(config =>
       {
           config.AddPolicy("AuthZPolicy", policyBuilder =>
               policyBuilder.Requirements.Add(new ScopeAuthorizationRequirement() { RequiredScopesConfigurationKey = $"AzureAd:Scopes" }));
       });
   
   // Add services to the container.
   builder.Services.AddRazorPages();
   
   var app = builder.Build();
   
   app.UseAuthentication();
   app.UseAuthorization();
   
   var weatherSummaries = new[]
       {
           "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
       };
   
   app.MapGet("/weatherforecast", [Authorize(Policy = "AuthZPolicy")] () =>
       {
           var forecast = Enumerable.Range(1, 5).Select(index =>
               new WeatherForecast
               (
                   DateTime.Now.AddDays(index),
                   Random.Shared.Next(-20, 55),
                   weatherSummaries[Random.Shared.Next(weatherSummaries.Length)]
               ))
               .ToArray();
           return forecast;
       })
       .WithName("GetWeatherForecast");
   
   // Configure the HTTP request pipeline.
   if (!app.Environment.IsDevelopment())
   {
       app.UseExceptionHandler("/Error");
       // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
       app.UseHsts();
   }
   
   app.UseHttpsRedirection();
   app.UseStaticFiles();
   
   app.UseRouting();
   
   app.UseAuthorization();
   
   app.MapRazorPages();
   
   app.Run();
   
   record WeatherForecast(DateTime Date, int TemperatureC, string? Summary)
   {
       public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
   } 
   

Testování aplikace

Visual Studio

1. V sadě Visual Studio vyberte Spustit bez ladění.

Visual Studio Code

1. Spusťte aplikaci zadáním následujícího příkazu v terminálu:

   dotnet run
   

2. V terminálu by se měl zobrazit podobný výstup jako následující. Tím potvrdíte, že aplikace běží http://localhost:{port} a naslouchá na žádostech.

   Building...
   info: Microsoft.Hosting.Lifetime[0]
       Now listening on: http://localhost:{port}
   info: Microsoft.Hosting.Lifetime[0]
       Application started. Press Ctrl+C to shut down.
   ...
   

Visual Studio pro Mac

1. Spusťte aplikaci tak , že vyberete Přehrát spuštěné řešení.

Poznámka:

Visual Studio pro Mac plánujeme do 31. srpna 2024 v souladu s Microsoftem Moderní zásady životního cyklu. Visual Studio pro Mac 17.6 bude nadále podporována až do 31. srpna 2024 s servisními aktualizacemi problémů se zabezpečením a aktualizovanými platformami od Společnosti Apple. Další informace najdete v tématu Co se děje Visual Studio pro Mac.

Webová stránka http://localhost:{host} zobrazí výstup podobný následujícímu obrázku. Důvodem je to, že se rozhraní API volá bez ověřování. Pokud chcete provést autorizované volání, přečtěte si další kroky s návody, jak získat přístup k chráněnému webovému rozhraní API.

Další kroky

Postupy: Volání rozhraní API pomocí cURL