Självstudie: Implementera en skyddad slutpunkt i ditt API

I den här självstudien får du lära dig hur du skyddar en API-slutpunkt genom att lägga till autentiseringselement i källkoden. Att skydda en API-slutpunkt säkerställer att endast behöriga användare får åtkomst. Du kan testa API:et med en oautentiserad begäran för att säkerställa att ditt API begränsar åtkomsten till obehöriga användare. Med Microsofts identitetsplattform kan du skydda API-slutpunkter med hjälp av NuGet-paketet Microsoft.Identity.Web. I den här artikeln, du;

• Implementera autentiseringselement i källkoden
• Lägga till väderinformation för API:et som ska visas
• Testa API:et med en oautentiserad GET-begäran

Förutsättningar

• Slutförande av förutsättningarna och stegen i Självstudie: Skapa och konfigurera ett ASP.NET Core-projekt för autentisering.

Implementera auktorisering

1. Öppna filen Program.cs och ersätt innehållet med följande kodfragment:

   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);
   } 
   

Testa programmet

Visual Studio

1. I Visual Studio väljer du Starta utan felsökning.

Visual Studio Code

1. Starta programmet genom att skriva följande i terminalen:

   dotnet run
   

2. Ett liknande utdata som följande ska visas i terminalen. Detta bekräftar att programmet körs på http://localhost:{port} och lyssnar efter begäranden.

   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 för Mac

1. Starta programmet genom att välja Spela upp den körbara lösningen.

Kommentar

Visual Studio för Mac beräknas gå i pension senast den 31 augusti 2024 i enlighet med Microsofts policy för modern livscykel. Visual Studio för Mac 17.6 fortsätter att stödjas fram till den 31 augusti 2024, med serviceuppdateringar för säkerhetsproblem och uppdaterade plattformar från Apple. Mer information finns i Vad som händer med Visual Studio för Mac.

Webbsidan http://localhost:{host} visar utdata som liknar följande bild. Det beror på att API:et anropas utan autentisering. Information om hur du får åtkomst till ett skyddat webb-API finns i Nästa steg för att göra ett auktoriserat anrop.

Nästa steg

Anvisningar: Anropa ett API med hjälp av cURL