README.md

AspNetCore.Examples.Auth

This project serves as an example of how to authenticate and authorize users in an ASP.Net Core application.

It makes use of the following technologies and projects:

• .NET 9.0
• ASP.NET Core 9.0
• SwaggerUI
• ScalaR
• OpenID Connect
• Duende Identity Server Demo
• XUnit
• FluentAssertions
• Coverlet
• ReportGenerator

How to run

Simply run the Web Api project from Visual Studio, or from a terminal by executing dotnet run --project .\AspNetCore.Examples.Auth.Api\AspNetCore.Examples.Auth.Api.csproj in the root folder.

Call the endpoints via SwaggerUI

Access the web api at http://localhost:5297/swagger and try to call the endpoints:

• Access /auth/anonymous to call an endpoint that requires no authentication.
• The rest of the endpoints should return 401 Unauthorized.
• Click the Authorize button to authenticate with Duende Identity Server. Use any of the suggested users in the login page (alice/alice or bob/bob at the time of writing).
  • Call the /auth/claims endpoint to check your claims.
  • Call the /auth/only-admin endpoint to use Role Based Authorization.
  • Call the /auth/only-alice or /auth/only-bob endpoints to use Claims Based Authorization.
  • Call the /auth/only-recent-login endpoint to use Policy Based Authorization.
  • Call the /auth/only-same-author endpoint with the authenticated user email (check in the /auth/claims endpoint) to use Resource Based Authorization.
  • Any of these calls should return 403 Forbidden if the requirements are not met.

Call the endpoints via ScalaR

Access the web api at http://localhost:5297/scalar/v1 and try to call the endpoints:

• Access /auth/anonymous to call an endpoint that requires no authentication.
• The rest of the endpoints should return 401 Unauthorized.
• At the time of writing ScalaR does not fully support OAuth 2.0, so the rest of the endpoints will not be accessible. See scalar/scalar#604

How to test

Simply run the tests from the Test Explorer in Visual Studio, or from a terminal by executing dotnet test in the root folder. More about ASP.NET Core 9.0 integration tests

To run tests and generate an html coverage analysis report, run the coverage_report.ps1 PowerShell script in the root folder. More about code coverage for unit testing in .NET