Implémenter l'authentification et l'autorisation basées sur l'identité dans les API minimales dans ASP.NET Core

Les API minimales dans ASP.NET Core nous permettent de créer des API légères avec un minimum de dépendances. Cependant, nous aurons souvent encore besoin d’une authentification et d’une autorisation dans nos API minimales.

Minimal APIs in ASP.NET Core offer a lightweight approach to building APIs with minimal dependencies. However, many scenarios still require authentication and authorization in these minimal APIs. ASP.NET Core provides several options for achieving this, including basic authentication, token-based authentication, and identity-based authentication.

Les API minimales dans ASP.NET Core offrent une approche légère pour créer des API avec un minimum de dépendances. Cependant, de nombreux scénarios nécessitent encore une authentification et une autorisation dans ces API minimales. ASP.NET Core propose plusieurs options pour y parvenir, notamment l'authentification de base, l'authentification basée sur les jetons et l'authentification basée sur l'identité.

We've covered implementing basic authentication in minimal APIs and JWT token-based authentication in minimal APIs. Now, let's explore how to implement identity-based authentication for minimal APIs in ASP.NET Core.

Nous avons couvert la mise en œuvre de l'authentification de base dans les API minimales et de l'authentification basée sur les jetons JWT dans les API minimales. Voyons maintenant comment implémenter l’authentification basée sur l’identité pour les API minimales dans ASP.NET Core.

To follow along with the code examples in this article, ensure you have Visual Studio 2022 installed on your system. If you don't have a copy, you can download Visual Studio 2022 here.

Pour suivre les exemples de code de cet article, assurez-vous que Visual Studio 2022 est installé sur votre système. Si vous n'en avez pas de copie, vous pouvez télécharger Visual Studio 2022 ici.

Creating an ASP.NET Core Web API Project in Visual Studio 2022

Création d'un projet d'API Web ASP.NET Core dans Visual Studio 2022

To create an ASP.NET Core Web API project in Visual Studio 2022, follow these steps:

Pour créer un projet d'API Web ASP.NET Core dans Visual Studio 2022, procédez comme suit :

We'll use this ASP.NET Core Web API project to work with the code examples given in the sections below.

Nous utiliserons ce projet d'API Web ASP.NET Core pour travailler avec les exemples de code donnés dans les sections ci-dessous.

Identity Management in ASP.NET Core

Gestion des identités dans ASP.NET Core

ASP.NET Core includes a powerful feature called identity management, which has been enhanced in .NET 8. The built-in Identity framework in ASP.NET Core provides the necessary middleware to implement authentication, user management, and role-based authorization, making it easier to implement robust and secure authentication mechanisms in your application.

ASP.NET Core inclut une fonctionnalité puissante appelée gestion des identités, qui a été améliorée dans .NET 8. L'infrastructure d'identité intégrée dans ASP.NET Core fournit le middleware nécessaire pour implémenter l'authentification, la gestion des utilisateurs et l'autorisation basée sur les rôles, ce qui rend il est plus facile de mettre en œuvre des mécanismes d'authentification robustes et sécurisés dans votre application.

ASP.NET Core's Identity framework is extensible and customizable, supporting the following key features:

Le framework d'identité d'ASP.NET Core est extensible et personnalisable, prenant en charge les fonctionnalités clés suivantes :

Creating a Minimal API in ASP.NET Core

Création d'une API minimale dans ASP.NET Core

In the Web API project we created above, replace the generated code with the following code to create a basic minimal API.

Dans le projet API Web que nous avons créé ci-dessus, remplacez le code généré par le code suivant pour créer une API minimale de base.

When you run the application, the text "Hello World!" will be displayed in your web browser. We'll use this endpoint later in this article.

Lorsque vous exécutez l'application, le texte « Hello World ! » sera affiché dans votre navigateur Web. Nous utiliserons ce point de terminaison plus loin dans cet article.

Installing NuGet Packages

Installation des packages NuGet

To add support for the built-in Identity framework in ASP.NET Core, select the project in the Solution Explorer window, then right-click and select "Manage NuGet Packages." In the NuGet Package Manager window, search for the Microsoft.AspNetCore.Identity.EntityFrameworkCore, Microsoft.EntityFrameworkCore.SqlServer, and Microsoft.EntityFrameworkCore.Design packages and install them.

Pour ajouter la prise en charge du framework d'identité intégré dans ASP.NET Core, sélectionnez le projet dans la fenêtre de l'Explorateur de solutions, puis cliquez avec le bouton droit et sélectionnez « Gérer les packages NuGet ». Dans la fenêtre NuGet Package Manager, recherchez les packages Microsoft.AspNetCore.Identity.EntityFrameworkCore, Microsoft.EntityFrameworkCore.SqlServer et Microsoft.EntityFrameworkCore.Design et installez-les.

Alternatively, you can install the packages via the NuGet Package Manager console by entering the commands listed below.

Vous pouvez également installer les packages via la console NuGet Package Manager en entrant les commandes répertoriées ci-dessous.

Creating a New DbContext in EF Core

Création d'un nouveau DbContext dans EF Core

We'll be using Entity Framework Core in this example. The DbContext is an integral component of EF Core that represents a connection session with the database. Next, create a custom DbContext class by extending the IdentityDbContext class as shown in the code snippet given below.

Nous utiliserons Entity Framework Core dans cet exemple. Le DbContext est un composant intégral d’EF Core qui représente une session de connexion avec la base de données. Ensuite, créez une classe DbContext personnalisée en étendant la classe IdentityDbContext comme indiqué dans l'extrait de code ci-dessous.

You should register the custom DbContext class by including the following line of code in the Program.cs file.

Vous devez enregistrer la classe DbContext personnalisée en incluant la ligne de code suivante dans le fichier Program.cs.

Enabling Authentication and Authorization in ASP.NET Core

Activation de l'authentification et de l'autorisation dans ASP.NET Core

Authentication is the process of determining who the user is and validating the user's identity. You can enable authentication in a minimal API in ASP.NET Core by using the AddAuthentication() method as shown in the code snippet given below.

L'authentification est le processus permettant de déterminer qui est l'utilisateur et de valider son identité. Vous pouvez activer l'authentification dans une API minimale dans ASP.NET Core en utilisant la méthode AddAuthentication() comme indiqué dans l'extrait de code ci-dessous.

We use authorization to restrict access to certain resources in an application. You can enable authorization in your minimal API by using the following code.

Nous utilisons l'autorisation pour restreindre l'accès à certaines ressources dans une application. Vous pouvez activer l'autorisation dans votre API minimale en utilisant le code suivant.

The AddAuthorization method is used to register authorization services with the services container so that you can define rules for enabling or disabling access to resources of the application if needed.

La méthode AddAuthorization est utilisée pour enregistrer les services d'autorisation auprès du conteneur de services afin que vous puissiez définir des règles pour activer ou désactiver l'accès aux ressources de l'application si nécessaire.

Configuring Services and API Endpoints in ASP.NET Core

Configuration des services et des points de terminaison d'API dans ASP.NET Core

The next thing we need to do is configure the identity and EF Core services and the API endpoints. To do this, include the code listing given below in the Program.cs file.

La prochaine chose que nous devons faire est de configurer les services d’identité et EF Core ainsi que les points de terminaison de l’API. Pour ce faire, incluez la liste de codes ci-dessous dans le fichier Program.cs.

The AddIdentityApiEndpoints() method in the preceding code snippet adds the necessary controllers and services for authentication and authorization (login, logout, registration, etc.). Note that this is a new method (introduced in .NET 8) used to configure Identity integration in an application. The AddIdentityApiEndpoints() method accepts an instance of type IdentityUser as a parameter, which is used to specify the type of user.

La méthode AddIdentityApiEndpoints() dans l'extrait de code précédent ajoute les contrôleurs et services nécessaires à l'authentification et à l'autorisation (connexion, déconnexion, enregistrement, etc.). Notez qu'il s'agit d'une nouvelle méthode (introduite dans .NET 8) utilisée pour configurer l'intégration d'identité dans une application. La méthode AddIdentityApiEndpoints() accepte une instance de type IdentityUser comme paramètre, qui est utilisée pour spécifier le type d'utilisateur.

You can use the following piece of code to add authorization for the /helloworld endpoint.

Vous pouvez utiliser le morceau de code suivant pour ajouter une autorisation pour le point de terminaison /helloworld.

Complete Program.cs File Source

Source complète du fichier Program.cs

The complete source code of the Program.cs file is given below for your reference.

Le code source complet du fichier Program.cs est donné ci-dessous pour votre référence.

The integrated identity management feature in ASP.NET Core is both powerful and easy to use. The improvements in .NET 8 have made Identity even more robust and flexible with an improved Identity API, which enables you to implement identity-based authentication and authorization more easily and efficiently with less code.

La fonctionnalité de gestion des identités intégrée dans ASP.NET Core est à la fois puissante et facile à utiliser. Les améliorations apportées à .NET 8 ont rendu Identity encore plus robuste et flexible grâce à une API d'identité améliorée, qui vous permet de mettre en œuvre l'authentification et l'autorisation basées sur l'identité plus facilement et plus efficacement avec moins de code.

Next read this:

Ensuite, lisez ceci :