Refactor claim extraction methods for receiver context

Renamed authentication-related extension methods to clarify that they extract claims for the "receiver" context (e.g., GetAuthReceiverSignature → GetReceiverSignatureOfReceiver). Updated all usages in AnnotationController and ReadOnlyController. Also renamed the helper method GetRequiredClaim to GetRequiredClaimOfReceiver for improved clarity and reduced ambiguity.
This commit is contained in:
2026-02-02 15:58:07 +01:00
parent 31fe1c34f2
commit b1aa6d6639
3 changed files with 15 additions and 15 deletions

View File

@@ -59,8 +59,8 @@ public class AnnotationController : ControllerBase
[Obsolete("PSPDF Kit will no longer be used.")] [Obsolete("PSPDF Kit will no longer be used.")]
public async Task<IActionResult> CreateOrUpdate([FromBody] PsPdfKitAnnotation? psPdfKitAnnotation = null, CancellationToken cancel = default) public async Task<IActionResult> CreateOrUpdate([FromBody] PsPdfKitAnnotation? psPdfKitAnnotation = null, CancellationToken cancel = default)
{ {
var signature = User.GetAuthReceiverSignature(); var signature = User.GetReceiverSignatureOfReceiver();
var uuid = User.GetAuthEnvelopeUuid(); var uuid = User.GetEnvelopeUuidOfReceiver();
var envelopeReceiver = await _mediator.ReadEnvelopeReceiverAsync(uuid, signature, cancel).ThrowIfNull(Exceptions.NotFound); var envelopeReceiver = await _mediator.ReadEnvelopeReceiverAsync(uuid, signature, cancel).ThrowIfNull(Exceptions.NotFound);
@@ -92,9 +92,9 @@ public class AnnotationController : ControllerBase
[Obsolete("Use MediatR")] [Obsolete("Use MediatR")]
public async Task<IActionResult> Reject([FromBody] string? reason = null) public async Task<IActionResult> Reject([FromBody] string? reason = null)
{ {
var signature = User.GetAuthReceiverSignature(); var signature = User.GetReceiverSignatureOfReceiver();
var uuid = User.GetAuthEnvelopeUuid(); var uuid = User.GetEnvelopeUuidOfReceiver();
var mail = User.GetAuthReceiverMail(); var mail = User.GetReceiverMailOfReceiver();
var envRcvRes = await _envelopeReceiverService.ReadByUuidSignatureAsync(uuid: uuid, signature: signature); var envRcvRes = await _envelopeReceiverService.ReadByUuidSignatureAsync(uuid: uuid, signature: signature);

View File

@@ -40,14 +40,14 @@ public class ReadOnlyController : ControllerBase
[Authorize(Roles = Role.Receiver.FullyAuth)] [Authorize(Roles = Role.Receiver.FullyAuth)]
public async Task<IActionResult> CreateAsync([FromBody] EnvelopeReceiverReadOnlyCreateDto createDto) public async Task<IActionResult> CreateAsync([FromBody] EnvelopeReceiverReadOnlyCreateDto createDto)
{ {
var authReceiverMail = User.GetAuthReceiverMail(); var authReceiverMail = User.GetReceiverMailOfReceiver();
if (authReceiverMail is null) if (authReceiverMail is null)
{ {
_logger.LogError("EmailAddress claim is not found in envelope-receiver-read-only creation process. Create DTO is:\n {dto}", JsonConvert.SerializeObject(createDto)); _logger.LogError("EmailAddress claim is not found in envelope-receiver-read-only creation process. Create DTO is:\n {dto}", JsonConvert.SerializeObject(createDto));
return Unauthorized(); return Unauthorized();
} }
var envelopeId = User.GetAuthEnvelopeId(); var envelopeId = User.GetEnvelopeIdOfReceiver();
createDto.AddedWho = authReceiverMail; createDto.AddedWho = authReceiverMail;
createDto.EnvelopeId = envelopeId; createDto.EnvelopeId = envelopeId;

View File

@@ -11,7 +11,7 @@ namespace EnvelopeGenerator.API.Extensions;
/// </summary> /// </summary>
public static class EnvelopeAuthExtensions public static class EnvelopeAuthExtensions
{ {
private static string GetRequiredClaim(this ClaimsPrincipal user, string claimType) private static string GetRequiredClaimOfReceiver(this ClaimsPrincipal user, string claimType)
{ {
var value = user.FindFirstValue(claimType); var value = user.FindFirstValue(claimType);
if (value is not null) if (value is not null)
@@ -30,34 +30,34 @@ public static class EnvelopeAuthExtensions
/// <summary> /// <summary>
/// Gets the authenticated envelope UUID from the claims. /// Gets the authenticated envelope UUID from the claims.
/// </summary> /// </summary>
public static string GetAuthEnvelopeUuid(this ClaimsPrincipal user) => user.GetRequiredClaim(ClaimTypes.NameIdentifier); public static string GetEnvelopeUuidOfReceiver(this ClaimsPrincipal user) => user.GetRequiredClaimOfReceiver(ClaimTypes.NameIdentifier);
/// <summary> /// <summary>
/// Gets the authenticated receiver signature from the claims. /// Gets the authenticated receiver signature from the claims.
/// </summary> /// </summary>
public static string GetAuthReceiverSignature(this ClaimsPrincipal user) => user.GetRequiredClaim(ClaimTypes.Hash); public static string GetReceiverSignatureOfReceiver(this ClaimsPrincipal user) => user.GetRequiredClaimOfReceiver(ClaimTypes.Hash);
/// <summary> /// <summary>
/// Gets the authenticated receiver display name from the claims. /// Gets the authenticated receiver display name from the claims.
/// </summary> /// </summary>
public static string GetAuthReceiverName(this ClaimsPrincipal user) => user.GetRequiredClaim(ClaimTypes.Name); public static string GetReceiverNameOfReceiver(this ClaimsPrincipal user) => user.GetRequiredClaimOfReceiver(ClaimTypes.Name);
/// <summary> /// <summary>
/// Gets the authenticated receiver email address from the claims. /// Gets the authenticated receiver email address from the claims.
/// </summary> /// </summary>
public static string GetAuthReceiverMail(this ClaimsPrincipal user) => user.GetRequiredClaim(ClaimTypes.Email); public static string GetReceiverMailOfReceiver(this ClaimsPrincipal user) => user.GetRequiredClaimOfReceiver(ClaimTypes.Email);
/// <summary> /// <summary>
/// Gets the authenticated envelope title from the claims. /// Gets the authenticated envelope title from the claims.
/// </summary> /// </summary>
public static string GetAuthEnvelopeTitle(this ClaimsPrincipal user) => user.GetRequiredClaim(EnvelopeClaimTypes.Title); public static string GetEnvelopeTitleOfReceiver(this ClaimsPrincipal user) => user.GetRequiredClaimOfReceiver(EnvelopeClaimTypes.Title);
/// <summary> /// <summary>
/// Gets the authenticated envelope identifier from the claims. /// Gets the authenticated envelope identifier from the claims.
/// </summary> /// </summary>
public static int GetAuthEnvelopeId(this ClaimsPrincipal user) public static int GetEnvelopeIdOfReceiver(this ClaimsPrincipal user)
{ {
var envIdStr = user.GetRequiredClaim(EnvelopeClaimTypes.Id); var envIdStr = user.GetRequiredClaimOfReceiver(EnvelopeClaimTypes.Id);
if (!int.TryParse(envIdStr, out var envId)) if (!int.TryParse(envIdStr, out var envId))
{ {
throw new InvalidOperationException($"Claim '{EnvelopeClaimTypes.Id}' is not a valid integer."); throw new InvalidOperationException($"Claim '{EnvelopeClaimTypes.Id}' is not a valid integer.");