Introduced a mechanism to limit repeated access code requests within a configurable time period using `IMemoryCache` and a new `RepeatRequestBlockingPeriod` configuration in `SendAccessCodeParams`. Key changes: - Added `SendAccessCodeParams` configuration to `appsettings.json`. - Updated DI in `DependencyInjection.cs` to include `SendAccessCodeParams`. - Enhanced `SendAccessCodeCommand` with `MultipleRequestsAllowed`. - Updated `SendAccessCodeCommandHandler` to handle caching logic: - Added `IsAccessCodeRequestsDisabled` and `DisableAccessCodeRequests`. - Modified `AuthController` to support `autoGenerated` query parameter. - Improved error handling and documentation. These changes ensure better control over access code requests and prevent abuse by limiting repeated requests within a configurable time window.
141 lines
6.4 KiB
C#
141 lines
6.4 KiB
C#
using DigitalData.Auth.Claims;
|
|
using EnvelopeGenerator.Application.Common.Interfaces.Services;
|
|
using EnvelopeGenerator.Application.EnvelopeReceivers.Queries;
|
|
using EnvelopeGenerator.Server.Controllers.Interfaces;
|
|
using EnvelopeGenerator.Server.Models;
|
|
using EnvelopeGenerator.Domain.Constants;
|
|
using MediatR;
|
|
using Microsoft.AspNetCore.Authentication;
|
|
using Microsoft.AspNetCore.Authentication.Cookies;
|
|
using Microsoft.AspNetCore.Authorization;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
using Microsoft.Extensions.Options;
|
|
using EnvelopeGenerator.Application.EnvelopeReceivers.Commands;
|
|
|
|
namespace EnvelopeGenerator.Server.Controllers;
|
|
|
|
/// <summary>
|
|
/// Controller verantwortlich für die Benutzer-Authentifizierung, einschließlich Anmelden, Abmelden und Überprüfung des Authentifizierungsstatus.
|
|
/// </summary>
|
|
[Route("api/[controller]")]
|
|
[ApiController]
|
|
public partial class AuthController(
|
|
IOptions<AuthTokenKeys> authTokenKeyOptions,
|
|
IAuthorizationService authService) : ControllerBase, IAuthController
|
|
{
|
|
private readonly AuthTokenKeys authTokenKeys = authTokenKeyOptions.Value;
|
|
|
|
/// <summary>
|
|
///
|
|
/// </summary>
|
|
public IAuthorizationService AuthService { get; } = authService;
|
|
|
|
/// <summary>
|
|
/// Entfernt das Authentifizierungs-Cookie des Benutzers (AuthCookie)
|
|
/// </summary>
|
|
/// <returns>
|
|
/// Gibt eine HTTP 200 oder 401.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// Sample request:
|
|
///
|
|
/// POST /api/auth/logout
|
|
///
|
|
/// </remarks>
|
|
/// <response code="200">Erfolgreich gelöscht, wenn der Benutzer ein berechtigtes Cookie hat.</response>
|
|
/// <response code="401">Wenn es kein zugelassenes Cookie gibt, wird „nicht zugelassen“ zurückgegeben.</response>
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
|
|
[Authorize(AuthenticationSchemes = AuthScheme.Sender)]
|
|
[HttpPost("logout")]
|
|
public IActionResult Logout()
|
|
{
|
|
Response.Cookies.Delete(authTokenKeys.Cookie);
|
|
return Ok();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Prüft, ob der Benutzer ein autorisiertes Token hat.
|
|
/// </summary>
|
|
/// <returns>Wenn ein autorisiertes Token vorhanden ist HTTP 200 asynchron 401</returns>
|
|
/// <remarks>
|
|
/// Sample request:
|
|
///
|
|
/// GET /api/auth
|
|
///
|
|
/// </remarks>
|
|
/// <response code="200">Wenn es einen autorisierten Cookie gibt.</response>
|
|
/// <response code="401">Wenn kein Cookie vorhanden ist oder nicht autorisierte.</response>
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
|
|
[HttpGet("check")]
|
|
[Authorize(AuthenticationSchemes = AuthScheme.Sender)]
|
|
public IActionResult Check(string? role = null)
|
|
=> role is not null && !User.IsInRole(role)
|
|
? Unauthorized()
|
|
: Ok();
|
|
|
|
/// <summary>
|
|
/// Checks whether the caller holds a valid per-envelope receiver token for the given envelope key.
|
|
/// The request must carry a cookie named <c>AuthTokenSignFLOWReceiver.{envelopeKey}</c>.
|
|
/// </summary>
|
|
/// <param name="envelopeKey">The unique envelope key extracted from the route.</param>
|
|
/// <response code="200">Valid per-envelope token found.</response>
|
|
/// <response code="401">Token is missing, expired or invalid.</response>
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
|
|
[Authorize(Policy = AuthPolicy.Receiver)]
|
|
[HttpGet("check/envelope/{envelopeKey}")]
|
|
public IActionResult CheckEnvelopeReceiver([FromRoute] string envelopeKey) => Ok();
|
|
|
|
/// <summary>
|
|
/// Sends the receiver access code e-mail on the first envelope login-page visit.
|
|
/// The operation is idempotent: if the code was already requested, it returns 200 without re-sending.
|
|
/// </summary>
|
|
/// <param name="key">Envelope receiver key.</param>
|
|
/// <param name="autoGenerated">If the access code was auto-generated while page is loading.</param>
|
|
/// <param name="sender">MediatR instance.</param>
|
|
/// <param name="cancel">Cancellation token.</param>
|
|
/// <response code="200">Access code is already available or requested successfully.</response>
|
|
/// <response code="404">Envelope receiver key was not found.</response>
|
|
/// <response code="500">Access code could not be persisted or e-mail could not be sent.</response>
|
|
[AllowAnonymous]
|
|
[HttpPost("envelope-receiver/{key}/request-access-code")]
|
|
public async Task<IActionResult> RequestEnvelopeReceiverAccessCode([FromServices] ISender sender, [FromRoute] string key, [FromQuery] bool autoGenerated = true, CancellationToken cancel = default)
|
|
=> await sender.Send(new SendAccessCodeCommand(key).AllowMultipleRequests(!autoGenerated), cancel) switch
|
|
{
|
|
SendAccessCodeResult.Sent => Ok(),
|
|
SendAccessCodeResult.AlreadySigned => Conflict(),
|
|
SendAccessCodeResult.NoAccessCodeRequired => NoContent(),
|
|
SendAccessCodeResult.RequestLimitExceeded => StatusCode(StatusCodes.Status429TooManyRequests),
|
|
_ => Problem(detail: "Unexpected result from SendAccessCodeCommand.", statusCode: StatusCodes.Status500InternalServerError)
|
|
};
|
|
|
|
/// <summary>
|
|
/// Removes the per-envelope receiver cookie for the given envelope key.
|
|
/// </summary>
|
|
/// <param name="envelopeKey">The unique envelope key whose cookie should be deleted.</param>
|
|
/// <response code="200">Cookie successfully deleted.</response>
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status200OK)]
|
|
[HttpPost("logout/envelope/{envelopeKey}")]
|
|
public IActionResult LogoutEnvelopeReceiver([FromRoute] string envelopeKey)
|
|
{
|
|
var cookieName = CookieNames.GetEnvelopeReceiverCookieName(authTokenKeys.Cookie, envelopeKey);
|
|
Response.Cookies.Delete(cookieName);
|
|
return Ok();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Removes all per-envelope receiver cookies from the current request.
|
|
/// </summary>
|
|
/// <response code="200">All envelope receiver cookies successfully deleted.</response>
|
|
[ProducesResponseType(typeof(void), StatusCodes.Status200OK)]
|
|
[HttpPost("logout/envelope")]
|
|
public IActionResult LogoutAllEnvelopeReceivers()
|
|
{
|
|
foreach (var cookieName in Request.Cookies.Keys.Where(k => CookieNames.IsEnvelopeReceiverCookie(k, authTokenKeys.Cookie)))
|
|
Response.Cookies.Delete(cookieName);
|
|
return Ok();
|
|
}
|
|
}
|