| | | 1 | | using Microsoft.AspNetCore.Authentication; |
| | | 2 | | using Microsoft.AspNetCore.Authentication.Cookies; |
| | | 3 | | using Microsoft.AspNetCore.Authorization; |
| | | 4 | | using Microsoft.AspNetCore.Mvc; |
| | | 5 | | using ProjectTemplate.Web.Authentication; |
| | | 6 | | using ProjectTemplate.Web.Models; |
| | | 7 | | |
| | | 8 | | namespace ProjectTemplate.Web.Controllers; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Provides actions for user authentication, including login, logout, and access denied handling. |
| | | 12 | | /// </summary> |
| | | 13 | | /// <remarks>This controller exposes endpoints for user authentication workflows. It supports external |
| | | 14 | | /// authentication providers and enforces security best practices such as requiring local return URLs to prevent open |
| | | 15 | | /// redirect vulnerabilities. Actions are decorated with appropriate authorization and anti-forgery attributes as |
| | | 16 | | /// needed.</remarks> |
| | | 17 | | /// <param name="schemeProvider">The authentication scheme provider used to retrieve available external authentication s |
| | | 18 | | /// Cannot be null.</param> |
| | 9 | 19 | | public class AccountController(IAuthenticationSchemeProvider schemeProvider) : Controller |
| | | 20 | | { |
| | 9 | 21 | | private readonly IAuthenticationSchemeProvider _schemeProvider = schemeProvider; |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// Displays the login page and provides available external authentication providers. |
| | | 25 | | /// </summary> |
| | | 26 | | /// <remarks>This action is accessible without authentication. Only local return URLs are permitted to |
| | | 27 | | /// prevent open redirect vulnerabilities.</remarks> |
| | | 28 | | /// <param name="returnUrl">The URL to redirect to after a successful login. If null or empty, the user is redirecte |
| | | 29 | | /// root. Must be a local URL.</param> |
| | | 30 | | /// <returns>A view result that renders the login page with available external authentication providers, or a bad re |
| | | 31 | | /// result if the return URL is not local.</returns> |
| | | 32 | | [HttpGet("/Account/Login")] |
| | | 33 | | [AllowAnonymous] |
| | | 34 | | public async Task<IActionResult> Login(string? returnUrl = null) |
| | | 35 | | { |
| | 5 | 36 | | string safeReturnUrl = string.IsNullOrWhiteSpace(returnUrl) ? "/" : returnUrl; |
| | | 37 | | |
| | 5 | 38 | | if (!Url.IsLocalUrl(safeReturnUrl)) |
| | | 39 | | { |
| | 1 | 40 | | return BadRequest(); |
| | | 41 | | } |
| | | 42 | | |
| | 4 | 43 | | IReadOnlyList<AuthenticationScheme> schemes = await ExternalAuthenticationProviderSchemes |
| | 4 | 44 | | .GetSelectableSchemesAsync(_schemeProvider); |
| | | 45 | | |
| | 4 | 46 | | AccountLoginViewModel model = new() |
| | 4 | 47 | | { |
| | 4 | 48 | | ReturnUrl = safeReturnUrl, |
| | 4 | 49 | | ExternalProviders = schemes |
| | 4 | 50 | | .Select(scheme => new ExternalAuthenticationProviderViewModel |
| | 4 | 51 | | { |
| | 4 | 52 | | Scheme = scheme.Name, |
| | 4 | 53 | | DisplayName = scheme.DisplayName ?? scheme.Name |
| | 4 | 54 | | }) |
| | 4 | 55 | | .OrderBy(provider => provider.DisplayName) |
| | 4 | 56 | | .ToList() |
| | 4 | 57 | | }; |
| | | 58 | | |
| | 4 | 59 | | return View(model); |
| | 5 | 60 | | } |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Signs out the current user and redirects to the specified return URL. |
| | | 64 | | /// </summary> |
| | | 65 | | /// <remarks>This action requires an authenticated user, a valid anti-forgery token, and only accepts local URLs for |
| | | 66 | | /// to help prevent cross-site request forgery and open redirect vulnerabilities.</remarks> |
| | | 67 | | /// <param name="returnUrl">The URL to redirect to after sign-out. If null or empty, defaults to the application's r |
| | | 68 | | /// local URL.</param> |
| | | 69 | | /// <returns>A redirect result to the specified local return URL if sign-out is successful; otherwise, a bad request |
| | | 70 | | /// if the return URL is not local.</returns> |
| | | 71 | | [Authorize] |
| | | 72 | | [HttpPost("/Account/Logout")] |
| | | 73 | | [ValidateAntiForgeryToken] |
| | | 74 | | public async Task<IActionResult> Logout(string? returnUrl = null) |
| | | 75 | | { |
| | 2 | 76 | | string safeReturnUrl = string.IsNullOrWhiteSpace(returnUrl) ? "/" : returnUrl; |
| | | 77 | | |
| | 2 | 78 | | if (!Url.IsLocalUrl(safeReturnUrl)) |
| | | 79 | | { |
| | 0 | 80 | | return BadRequest(); |
| | | 81 | | } |
| | | 82 | | |
| | 2 | 83 | | await HttpContext.SignOutAsync(CookieAuthenticationDefaults.AuthenticationScheme); |
| | | 84 | | |
| | 2 | 85 | | return LocalRedirect(safeReturnUrl); |
| | 2 | 86 | | } |
| | | 87 | | |
| | | 88 | | /// <summary> |
| | | 89 | | /// Handles requests to the access denied page and returns a view indicating that the user does not have permission |
| | | 90 | | /// to access the requested resource. |
| | | 91 | | /// </summary> |
| | | 92 | | /// <remarks>This action is accessible to all users, including unauthenticated users. The response status |
| | | 93 | | /// code is set to 403 to indicate forbidden access.</remarks> |
| | | 94 | | /// <returns>A view result that displays the access denied page with a 403 Forbidden status code.</returns> |
| | | 95 | | [HttpGet("/Account/AccessDenied")] |
| | | 96 | | [AllowAnonymous] |
| | | 97 | | public IActionResult AccessDenied() |
| | | 98 | | { |
| | 2 | 99 | | Response.StatusCode = StatusCodes.Status403Forbidden; |
| | 2 | 100 | | return View(); |
| | | 101 | | } |
| | | 102 | | } |