Azuredevopswiki

[[_TOC_]]

# Implementing OAuth 2.0 in an ASP.Net MVC .NET 8 Web Application

This guide will help you implement OAuth 2.0 authentication in an ASP.Net MVC .Net 8 web application. OAuth 2.0 is a widely used authorization framework that enables third-party applications to obtain limited access to a web service.

## Prerequisites

- Visual Studio 2022 or later
- .NET 8 SDK
- An existing ASP.Net MVC project

## Step 1: Install Required Packages

First, you need to install the necessary NuGet packages for OAuth 2.0 authentication.

```bash
dotnet add package Microsoft.AspNetCore.Authentication.OAuth
dotnet add package Microsoft.AspNetCore.Authentication.Cookies
```

## Step 2: Configure Authentication Middleware

Add the authentication middleware to your `Startup.cs` file.

```csharp
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllersWithViews();
        
        services.AddAuthentication(options =>
        {
            options.DefaultAuthenticateScheme = CookieAuthenticationDefaults.AuthenticationScheme;
            options.DefaultSignInScheme = CookieAuthenticationDefaults.AuthenticationScheme;
            options.DefaultChallengeScheme = "OAuthProvider"; // Name your OAuth provider
        })
        .AddCookie()
        .AddOAuth("OAuthProvider", options =>
        {
            options.ClientId = "your-client-id";
            options.ClientSecret = "your-client-secret";
            options.CallbackPath = new PathString("/signin-oauth");
            options.AuthorizationEndpoint = "https://oauth-provider.com/auth";
            options.TokenEndpoint = "https://oauth-provider.com/token";
            options.SaveTokens = true;

            options.Events.OnCreatingTicket = async context =>
            {
                // Add claims or custom logic here
            };
        });
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
            app.UseHsts();
        }

        app.UseHttpsRedirection();
        app.UseStaticFiles();

        app.UseRouting();

        app.UseAuthentication();
        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllerRoute(
                name: "default",
                pattern: "{controller=Home}/{action=Index}/{id?}");
        });
    }
}
```

## Step 3: Protect Routes with Authentication

Ensure your routes are protected by adding the `[Authorize]` attribute to your controllers or actions.

```csharp
[Authorize]
public class HomeController : Controller
{
    public IActionResult Index()
    {
        return View();
    }

    public IActionResult Privacy()
    {
        return View();
    }
}
```

## Step 4: Create Login and Logout Actions

Add login and logout actions to your account controller.

```csharp
public class AccountController : Controller
{
    [HttpGet]
    public IActionResult Login()
    {
        return Challenge(new AuthenticationProperties { RedirectUri = "/" }, "OAuthProvider");
    }

    [HttpGet]
    public IActionResult Logout()
    {
        return SignOut(new AuthenticationProperties { RedirectUri = "/" }, CookieAuthenticationDefaults.AuthenticationScheme);
    }
}
```

## Step 5: Add Login and Logout Links

Add login and logout links to your `_Layout.cshtml` file.

```html
<ul class="navbar-nav">
    <li class="nav-item">
        <a class="nav-link" asp-controller="Account" asp-action="Login">Login</a>
    </li>
    <li class="nav-item">
        <a class="nav-link" asp-controller="Account" asp-action="Logout">Logout</a>
    </li>
</ul>
```

## Step 6: Run the Application

Run your application and navigate to the login link. You should be redirected to the OAuth provider's login page. After successful login, you will be redirected back to your application.

## Summary

By following these steps, you have successfully implemented OAuth 2.0 authentication in your ASP.Net MVC .Net 8 web application. This setup allows your application to securely authenticate users using an external OAuth provider.