Limit repeated access code requests via caching

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.
This commit is contained in:
2026-11-16 13:11:31 +01:00
parent 93d9aa0742
commit 6c9b8ad3a8
5 changed files with 76 additions and 8 deletions

View File

@@ -12,6 +12,7 @@ using EnvelopeGenerator.Application.DocReceiverElements.Commands;
using EnvelopeGenerator.Application.DocReceiverElements.Behaviors;
using EnvelopeGenerator.Application.Common.Behaviors;
using FluentValidation;
using EnvelopeGenerator.Application.EnvelopeReceivers.Commands;
namespace EnvelopeGenerator.Application;
@@ -53,6 +54,7 @@ public static class DependencyInjection
services.Configure<AuthenticatorParams>(config.GetSection(nameof(AuthenticatorParams)));
services.Configure<TotpSmsParams>(config.GetSection(nameof(TotpSmsParams)));
services.Configure<ESignParams>(config.GetSection(nameof(ESignParams)));
services.Configure<SendAccessCodeParams>(config.GetSection(nameof(SendAccessCodeParams)));
services.AddHttpClientService<GtxMessagingParams>(config.GetSection(nameof(GtxMessagingParams)));
services.TryAddScoped<ISmsSender, GTXSmsSender>(); // Changed: Singleton → Scoped

View File

@@ -6,6 +6,8 @@ using EnvelopeGenerator.Application.EnvelopeReceivers.Queries;
using EnvelopeGenerator.Domain.Constants;
using EnvelopeGenerator.Domain.Exceptions;
using MediatR;
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Options;
namespace EnvelopeGenerator.Application.EnvelopeReceivers.Commands;
@@ -15,7 +17,17 @@ namespace EnvelopeGenerator.Application.EnvelopeReceivers.Commands;
/// <param name="Key"></param>
public record SendAccessCodeCommand(string Key) : IRequest<SendAccessCodeResult>
{
internal bool MultipleRequestsAllowed { get; private set; } = false;
/// <summary>
///
/// </summary>
/// <returns></returns>
public SendAccessCodeCommand AllowMultipleRequests(bool allow = true)
{
MultipleRequestsAllowed = allow;
return this;
}
}
/// <summary>
@@ -47,8 +59,13 @@ public enum SendAccessCodeResult
/// <summary>
///
/// </summary>
public class SendAccessCodeCommandHandler(IMediator Sender, IEnvelopeHistoryService HistoryService, IEnvelopeNotificationService NtfService) : IRequestHandler<SendAccessCodeCommand, SendAccessCodeResult>
public class SendAccessCodeCommandHandler(IMediator Sender, IEnvelopeHistoryService HistoryService, IEnvelopeNotificationService NtfService, IOptions<SendAccessCodeParams> options, IMemoryCache Cache) : IRequestHandler<SendAccessCodeCommand, SendAccessCodeResult>
{
/// <summary>
///
/// </summary>
public readonly SendAccessCodeParams Options = options.Value;
/// <summary>
///
/// </summary>
@@ -75,16 +92,20 @@ public class SendAccessCodeCommandHandler(IMediator Sender, IEnvelopeHistoryServ
return SendAccessCodeResult.AlreadySigned;
var accessCodeAlreadyRequested = await HistoryService.AccessCodeAlreadyRequested(er.EnvelopeId, userReference);
if (accessCodeAlreadyRequested)
if (accessCodeAlreadyRequested && (!request.MultipleRequestsAllowed || await IsAccessCodeRequestsDisabled(request.Key, cancel)))
return SendAccessCodeResult.RequestLimitExceeded;
var historyResult = await HistoryService.RecordAsync(er.EnvelopeId, userReference, EnvelopeStatus.AccessCodeRequested);
if (historyResult.IsFailed)
// create a history record
if (!accessCodeAlreadyRequested)
{
throw new ApplicationException($"Failed to record AccessCodeRequested history for envelope {er.EnvelopeId} and receiver {userReference}.");
var historyResult = await HistoryService.RecordAsync(er.EnvelopeId, userReference, EnvelopeStatus.AccessCodeRequested);
if (historyResult.IsFailed)
{
throw new ApplicationException($"Failed to record AccessCodeRequested history for envelope {er.EnvelopeId} and receiver {userReference}.");
}
}
if(er.AccessCode is null)
if (er.AccessCode is null)
throw new DataIntegrityException($"Access code is null for envelope receiver with key '{request.Key}' although use-access-code is true.");
await NtfService.Notify(er.Receiver.EmailAddress, new DocumentAccessCodeReceivedNotification()
@@ -96,6 +117,35 @@ public class SendAccessCodeCommandHandler(IMediator Sender, IEnvelopeHistoryServ
NameSender = er.Envelope.User!.Username,
}, cancel);
await DisableAccessCodeRequests(request.Key, cancel);
return SendAccessCodeResult.Sent;
}
private static string DisableAccessCodeRequestsCacheKeyPrefix => "DisableAccessCodeRequests_";
/// <summary>
///
/// </summary>
/// <param name="envelopeKey"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
private Task<bool> IsAccessCodeRequestsDisabled(string envelopeKey, CancellationToken cancellationToken = default)
{
bool hasCache = Cache.TryGetValue<bool>(DisableAccessCodeRequestsCacheKeyPrefix + envelopeKey, out var disabled);
return Task.FromResult(hasCache && disabled);
}
/// <summary>
///
/// </summary>
/// <param name="envelopeKey"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
private Task DisableAccessCodeRequests(string envelopeKey, CancellationToken cancellationToken = default)
{
Cache.Set(DisableAccessCodeRequestsCacheKeyPrefix + envelopeKey, true, Options.RepeatRequestBlockingPeriod);
return Task.CompletedTask;
}
}

View File

@@ -0,0 +1,12 @@
namespace EnvelopeGenerator.Application.EnvelopeReceivers.Commands;
/// <summary>
///
/// </summary>
public record SendAccessCodeParams
{
/// <summary>
///
/// </summary>
public TimeSpan RepeatRequestBlockingPeriod { get; init; } = TimeSpan.FromMinutes(1);
}