Schnellstart: Schützen einer ASP.NET Core-Web-API mit Microsoft Identity PlatformQuickstart: Protect an ASP.NET Core web API with Microsoft identity platform

• 09/22/2020
• 4 Minuten Lesedauer
• • j
  • o

In dieser Schnellstartanleitung laden Sie ein ASP.NET Core-Web-API-Codebeispiel herunter und überprüfen den Code, der den Zugriff auf Ressourcen auf autorisierte Konten beschränkt.In this quickstart, you download an ASP.NET Core web API code sample and review its code that restricts access to resources to authorized accounts only. Das Beispiel unterstützt die Autorisierung von persönlichen Microsoft-Konten sowie Konten in einer beliebigen Azure AD-Organisation (Azure Active Directory).The sample supports authorization of personal Microsoft accounts and accounts in any Azure Active Directory (Azure AD) organization.

Schritt 2: Herunterladen des ASP.NET Core-ProjektsStep 2: Download the ASP.NET Core project

Funktionsweise des BeispielsHow the sample works

Die Web-API empfängt ein Token von einer Clientanwendung, und das Token wird durch den Code in der Web-API überprüft.The web API receives a token from a client application, and the code in the web API validates the token. Eine ausführlichere Erläuterung dieses Szenarios finden Sie unter Szenario: Geschützte Web-API.This scenario is explained in more detail in Scenario: Protected web API.

StartklasseStartup class

Von der Middleware Microsoft.AspNetCore.Authentication wird eine Klasse vom Typ Startup verwendet, die ausgeführt wird, wenn der Hostprozess initialisiert wird.The Microsoft.AspNetCore.Authentication middleware uses a Startup class that's executed when the hosting process initializes. In der zugehörigen Methode ConfigureServices wird die von Microsoft.Identity.Web bereitgestellte Erweiterungsmethode AddMicrosoftIdentityWebApi aufgerufen.In its ConfigureServices method, the AddMicrosoftIdentityWebApi extension method provided by Microsoft.Identity.Web is called.

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
                .AddMicrosoftIdentityWebApi(Configuration, "AzureAd");
    }

Durch die Methode AddAuthentication() wird der Dienst konfiguriert, um die JwtBearer-basierte Authentifizierung hinzuzufügen.The AddAuthentication() method configures the service to add JwtBearer-based authentication.

Durch die Zeile mit .AddMicrosoftIdentityWebApi wird Ihrer Web-API die Microsoft Identity Platform-Autorisierung hinzugefügt.The line containing .AddMicrosoftIdentityWebApi adds Microsoft identity platform authorization to your web API. Diese wird anschließend für die Überprüfung von Zugriffstoken konfiguriert, die vom Microsoft Identity Platform-Endpunkt ausgegeben werden – basierend auf den Informationen im Abschnitt AzureAD der Konfigurationsdatei appsettings.json:It's then configured to validate access tokens issued by the Microsoft identity platform endpoint based on the information in the AzureAD section of the appsettings.json configuration file:

Die Methode Configure() enthält mit app.UseAuthentication() und app.UseAuthorization() zwei wichtige Methoden, um die genannte Funktion zu aktivieren:The Configure() method contains two important methods, app.UseAuthentication() and app.UseAuthorization(), that enable their named functionality:

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    // more code
    app.UseAuthentication();
    app.UseAuthorization();
    // more code
}

Schützen eines Controllers, der Methode eines Controllers oder einer Razor-SeiteProtect a controller, a controller's method, or a Razor page

Sie können einen Controller oder Controllermethoden mithilfe des [Authorize]-Attributs schützen.You can protect a controller or controller methods using the [Authorize] attribute. Dieses Attribut schränkt den Zugriff auf den Controller oder seine Methoden ein, indem es nur authentifizierte Benutzer zulässt. Das bedeutet, dass eine Authentifizierungsaufforderung für den Zugriff auf den Controller gestartet werden kann, wenn der Benutzer nicht authentifiziert ist.This attribute restricts access to the controller or methods by only allowing authenticated users, which means that authentication challenge can be started to access the controller if the user isn't authenticated.

namespace webapi.Controllers
{
    [Authorize]
    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase

Überprüfen des Bereichs im ControllerValidate the scope in the controller

Anschließend wird durch den Code in der API mithilfe von HttpContext.VerifyUserHasAnyAcceptedScope(scopeRequiredByApi); überprüft, ob die erforderlichen Bereiche im Token enthalten sind.The code in the API then verifies that the required scopes are in the token by using HttpContext.VerifyUserHasAnyAcceptedScope(scopeRequiredByApi);

namespace webapi.Controllers
{
    [Authorize]
    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        // The Web API will only accept tokens 1) for users, and 2) having the "access_as_user" scope for this API
        static readonly string[] scopeRequiredByApi = new string[] { "access_as_user" };

        [HttpGet]
        public IEnumerable<WeatherForecast> Get()
        {
            HttpContext.VerifyUserHasAnyAcceptedScope(scopeRequiredByApi);

            // some code here
        }
    }
}

Hilfe und SupportHelp and support

Wenn Sie Hilfe benötigen, ein Problem melden möchten oder sich über Ihre Supportoptionen informieren möchten, finden Sie weitere Informationen unter Hilfe und Support für Entwickler.If you need help, want to report an issue, or want to learn about your support options, see Help and support for developers.

Nächste SchritteNext steps

Das GitHub-Repository mit diesem Codebeispiel für die ASP.NET Core-Web-API enthält Anleitungen und weitere Codebeispiele für Folgendes:The GitHub repository that contains this ASP.NET Core web API code sample includes instructions and more code samples that show you how to:

• Hinzufügen einer Authentifizierung zu einer neuen ASP.NET Core-Web-APIAdd authentication to a new ASP.NET Core web API
• Aufrufen der Web-API über eine DesktopanwendungCall the web API from a desktop application
• Aufrufen von Downstream-APIs wie Microsoft Graph und anderen Microsoft-APIsCall downstream APIs like Microsoft Graph and other Microsoft APIs