AppStd/EnvelopeGenerator
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Refactor: unify role constants under new Role class

Browse Source 
Replaced all usages of ReceiverRole with the new Role class in EnvelopeGenerator.Domain.Constants. Removed ReceiverRole.cs and added Role.cs with PreAuth and FullyAuth constants. Updated all [Authorize] attributes and role checks in controllers and authentication logic to use Role.FullyAuth and Role.PreAuth. This centralizes role management for improved maintainability and clarity.
This commit is contained in:
tekh
2026-02-02 11:53:26 +01:00
parent a60d0f63e2
commit 6b23dcdba7
10 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
EnvelopeGenerator.API/Controllers/AnnotationController.cs
View File

@@ -18,7 +18,7 @@ namespace EnvelopeGenerator.API.Controllers;
/// <summary> /// <summary>
/// Manages annotations and signature lifecycle for envelopes. /// Manages annotations and signature lifecycle for envelopes.
/// </summary> /// </summary>
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[ApiController] [ApiController]
[Route("api/[controller]")] [Route("api/[controller]")]
public class AnnotationController : ControllerBase public class AnnotationController : ControllerBase
@@ -54,7 +54,7 @@ public class AnnotationController : ControllerBase
/// </summary> /// </summary>
/// <param name="psPdfKitAnnotation">Annotation payload.</param> /// <param name="psPdfKitAnnotation">Annotation payload.</param>
/// <param name="cancel">Cancellation token.</param> /// <param name="cancel">Cancellation token.</param>
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[HttpPost] [HttpPost]
[Obsolete("This endpoint is for PSPDF Kit.")] [Obsolete("This endpoint is for PSPDF Kit.")]
public async Task<IActionResult> CreateOrUpdate([FromBody] PsPdfKitAnnotation? psPdfKitAnnotation = null, CancellationToken cancel = default) public async Task<IActionResult> CreateOrUpdate([FromBody] PsPdfKitAnnotation? psPdfKitAnnotation = null, CancellationToken cancel = default)
@@ -93,7 +93,7 @@ public class AnnotationController : ControllerBase
/// Rejects the document for the current receiver. /// Rejects the document for the current receiver.
/// </summary> /// </summary>
/// <param name="reason">Optional rejection reason.</param> /// <param name="reason">Optional rejection reason.</param>
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[HttpPost("reject")] [HttpPost("reject")]
[Obsolete("Use MediatR")] [Obsolete("Use MediatR")]
public async Task<IActionResult> Reject([FromBody] string? reason = null) public async Task<IActionResult> Reject([FromBody] string? reason = null)

2
EnvelopeGenerator.API/Controllers/DocumentController.cs
View File

@@ -14,7 +14,7 @@ namespace EnvelopeGenerator.API.Controllers;
/// <remarks> /// <remarks>
/// Initializes a new instance of the <see cref="DocumentController"/> class. /// Initializes a new instance of the <see cref="DocumentController"/> class.
/// </remarks> /// </remarks>
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[ApiController] [ApiController]
[Route("api/[controller]")] [Route("api/[controller]")]
public class DocumentController(IMediator mediator, ILogger<DocumentController> logger) : ControllerBase public class DocumentController(IMediator mediator, ILogger<DocumentController> logger) : ControllerBase

2
EnvelopeGenerator.API/Controllers/ReadOnlyController.cs
View File

@@ -37,7 +37,7 @@ public class ReadOnlyController : ControllerBase
/// </summary> /// </summary>
/// <param name="createDto">Creation payload.</param> /// <param name="createDto">Creation payload.</param>
[HttpPost] [HttpPost]
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
public async Task<IActionResult> CreateAsync([FromBody] EnvelopeReceiverReadOnlyCreateDto createDto) public async Task<IActionResult> CreateAsync([FromBody] EnvelopeReceiverReadOnlyCreateDto createDto)
{ {
var authReceiverMail = User.GetAuthReceiverMail(); var authReceiverMail = User.GetAuthReceiverMail();

2
EnvelopeGenerator.API/Controllers/TfaRegistrationController.cs
View File

@@ -111,7 +111,7 @@ public class TfaRegistrationController : ControllerBase
/// <summary> /// <summary>
/// Logs out the envelope receiver from cookie authentication. /// Logs out the envelope receiver from cookie authentication.
/// </summary> /// </summary>
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[HttpPost("auth/logout")] [HttpPost("auth/logout")]
public async Task<IActionResult> LogOutAsync() public async Task<IActionResult> LogOutAsync()
{ {

2
EnvelopeGenerator.Domain/Constants/ReceiverRole.cs → EnvelopeGenerator.Domain/Constants/Role.cs
View File

@@ -1,6 +1,6 @@
namespace EnvelopeGenerator.Domain.Constants namespace EnvelopeGenerator.Domain.Constants
{ {
public static class ReceiverRole public static class Role
{ {
public const string PreAuth = "PreAuth"; public const string PreAuth = "PreAuth";
public const string FullyAuth = "FullyAuth"; public const string FullyAuth = "FullyAuth";

6
EnvelopeGenerator.Web/Controllers/AnnotationController.cs
View File

@@ -15,7 +15,7 @@ using Microsoft.AspNetCore.Mvc;
namespace EnvelopeGenerator.Web.Controllers; namespace EnvelopeGenerator.Web.Controllers;
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[ApiController] [ApiController]
[Route("api/[controller]")] [Route("api/[controller]")]
public class AnnotationController : ControllerBase public class AnnotationController : ControllerBase
@@ -42,7 +42,7 @@ public class AnnotationController : ControllerBase
_logger = logger; _logger = logger;
} }
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[HttpPost] [HttpPost]
public async Task<IActionResult> CreateOrUpdate([FromBody] PsPdfKitAnnotation? psPdfKitAnnotation = null, CancellationToken cancel = default) public async Task<IActionResult> CreateOrUpdate([FromBody] PsPdfKitAnnotation? psPdfKitAnnotation = null, CancellationToken cancel = default)
{ {
@@ -80,7 +80,7 @@ public class AnnotationController : ControllerBase
return Ok(); return Ok();
} }
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[HttpPost("reject")] [HttpPost("reject")]
[Obsolete("Use DigitalData.Core.Exceptions and .Middleware")] [Obsolete("Use DigitalData.Core.Exceptions and .Middleware")]
public async Task<IActionResult> Reject([FromBody] string? reason = null) public async Task<IActionResult> Reject([FromBody] string? reason = null)

2
EnvelopeGenerator.Web/Controllers/DocumentController.cs
View File

@@ -8,7 +8,7 @@ using Microsoft.AspNetCore.Mvc;
namespace EnvelopeGenerator.Web.Controllers; namespace EnvelopeGenerator.Web.Controllers;
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[ApiController] [ApiController]
[Route("api/[controller]")] [Route("api/[controller]")]
public class DocumentController : ControllerBase public class DocumentController : ControllerBase

18
EnvelopeGenerator.Web/Controllers/EnvelopeController.cs
View File

@@ -107,7 +107,7 @@ public class EnvelopeController : ViewControllerBase
return this.ViewEnvelopeNotFound(); return this.ViewEnvelopeNotFound();
} }
var er_secret = er_secret_res.Data; var er_secret = er_secret_res.Data;
await HttpContext.SignInEnvelopeAsync(er_secret, ReceiverRole.FullyAuth); await HttpContext.SignInEnvelopeAsync(er_secret, Role.FullyAuth);
return await CreateShowEnvelopeView(er_secret); return await CreateShowEnvelopeView(er_secret);
} }
#endregion UseAccessCode #endregion UseAccessCode
@@ -172,7 +172,7 @@ public class EnvelopeController : ViewControllerBase
} }
// show envelope if already logged in // show envelope if already logged in
if (User.IsInRole(ReceiverRole.FullyAuth)) if (User.IsInRole(Role.FullyAuth))
return await CreateShowEnvelopeView(er_secret); return await CreateShowEnvelopeView(er_secret);
if (auth.HasMulti) if (auth.HasMulti)
@@ -206,7 +206,7 @@ public class EnvelopeController : ViewControllerBase
.WithData("ErrorMessage", _localizer.WrongEnvelopeReceiverId()); .WithData("ErrorMessage", _localizer.WrongEnvelopeReceiverId());
} }
await HttpContext.SignInEnvelopeAsync(er_secret, ReceiverRole.FullyAuth); await HttpContext.SignInEnvelopeAsync(er_secret, Role.FullyAuth);
return await CreateShowEnvelopeView(er_secret); return await CreateShowEnvelopeView(er_secret);
} }
@@ -225,9 +225,9 @@ public class EnvelopeController : ViewControllerBase
&& uuidClaim == er.Envelope?.Uuid && uuidClaim == er.Envelope?.Uuid
&& signatureClaim is not null && signatureClaim is not null
&& signatureClaim == er.Receiver?.Signature && signatureClaim == er.Receiver?.Signature
&& User.IsInRole(ReceiverRole.FullyAuth)) && User.IsInRole(Role.FullyAuth))
{ {
await HttpContext.SignInEnvelopeAsync(er, ReceiverRole.FullyAuth); await HttpContext.SignInEnvelopeAsync(er, Role.FullyAuth);
//add PSPDFKit licence key //add PSPDFKit licence key
ViewData["PSPDFKitLicenseKey"] = _configuration["PSPDFKitLicenseKey"]; ViewData["PSPDFKitLicenseKey"] = _configuration["PSPDFKitLicenseKey"];
@@ -262,7 +262,7 @@ public class EnvelopeController : ViewControllerBase
return this.ViewDocumentNotFound(); return this.ViewDocumentNotFound();
} }
await HttpContext.SignInEnvelopeAsync(er, ReceiverRole.FullyAuth); await HttpContext.SignInEnvelopeAsync(er, Role.FullyAuth);
ViewData["ReadAndConfirm"] = er.Envelope.ReadOnly; ViewData["ReadAndConfirm"] = er.Envelope.ReadOnly;
@@ -334,7 +334,7 @@ public class EnvelopeController : ViewControllerBase
await _rcvService.UpdateAsync(rcv); await _rcvService.UpdateAsync(rcv);
} }
await HttpContext.SignInEnvelopeAsync(er_secret, ReceiverRole.PreAuth); await HttpContext.SignInEnvelopeAsync(er_secret, Role.PreAuth);
return await TFAViewAsync(auth.UserSelectSMS, er_secret, envelopeReceiverId); return await TFAViewAsync(auth.UserSelectSMS, er_secret, envelopeReceiverId);
} }
@@ -348,7 +348,7 @@ public class EnvelopeController : ViewControllerBase
if (er_secret.Receiver!.TotpSecretkey is null) if (er_secret.Receiver!.TotpSecretkey is null)
throw new InvalidOperationException($"TotpSecretkey of DTO cannot validate without TotpSecretkey. Dto: {JsonConvert.SerializeObject(er_secret)}"); throw new InvalidOperationException($"TotpSecretkey of DTO cannot validate without TotpSecretkey. Dto: {JsonConvert.SerializeObject(er_secret)}");
if (!User.IsInRole(ReceiverRole.PreAuth) || !_envSmsHandler.VerifyTotp(auth.SmsCode!, er_secret.Receiver.TotpSecretkey)) if (!User.IsInRole(Role.PreAuth) || !_envSmsHandler.VerifyTotp(auth.SmsCode!, er_secret.Receiver.TotpSecretkey))
{ {
Response.StatusCode = StatusCodes.Status401Unauthorized; Response.StatusCode = StatusCodes.Status401Unauthorized;
ViewData["ErrorMessage"] = _localizer.WrongAccessCode(); ViewData["ErrorMessage"] = _localizer.WrongAccessCode();
@@ -364,7 +364,7 @@ public class EnvelopeController : ViewControllerBase
if (er_secret.Receiver!.TotpSecretkey is null) if (er_secret.Receiver!.TotpSecretkey is null)
throw new InvalidOperationException($"TotpSecretkey of DTO cannot validate without TotpSecretkey. Dto: {JsonConvert.SerializeObject(er_secret)}"); throw new InvalidOperationException($"TotpSecretkey of DTO cannot validate without TotpSecretkey. Dto: {JsonConvert.SerializeObject(er_secret)}");
if (!User.IsInRole(ReceiverRole.PreAuth) || !_authenticator.VerifyTotp(auth.AuthenticatorCode!, er_secret.Receiver.TotpSecretkey, window: VerificationWindow.RfcSpecifiedNetworkDelay)) if (!User.IsInRole(Role.PreAuth) || !_authenticator.VerifyTotp(auth.AuthenticatorCode!, er_secret.Receiver.TotpSecretkey, window: VerificationWindow.RfcSpecifiedNetworkDelay))
{ {
Response.StatusCode = StatusCodes.Status401Unauthorized; Response.StatusCode = StatusCodes.Status401Unauthorized;
ViewData["ErrorMessage"] = _localizer.WrongAccessCode(); ViewData["ErrorMessage"] = _localizer.WrongAccessCode();

2
EnvelopeGenerator.Web/Controllers/ReadOnlyController.cs
View File

@@ -34,7 +34,7 @@ namespace EnvelopeGenerator.Web.Controllers
} }
[HttpPost] [HttpPost]
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[Obsolete("Use MediatR")] [Obsolete("Use MediatR")]
public async Task<IActionResult> CreateAsync([FromBody] EnvelopeReceiverReadOnlyCreateDto createDto) public async Task<IActionResult> CreateAsync([FromBody] EnvelopeReceiverReadOnlyCreateDto createDto)
{ {

2
EnvelopeGenerator.Web/Controllers/TFARegController.cs
View File

@@ -91,7 +91,7 @@ public class TFARegController : ViewControllerBase
} }
} }
[Authorize(Roles = ReceiverRole.FullyAuth)] [Authorize(Roles = Role.FullyAuth)]
[HttpPost("auth/logout")] [HttpPost("auth/logout")]
public async Task<IActionResult> LogOut() public async Task<IActionResult> LogOut()
{ {