Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Refactor ClientHeader calls to use base controller (#2159)

Leendert de Borst0398c4a85e0b
diff --git a/apps/server/AliasVault.Api/Controllers/Abstracts/AuthenticatedRequestController.cs b/apps/server/AliasVault.Api/Controllers/Abstracts/AuthenticatedRequestController.cs
index 18fb46282..38b1efa0a 100644
--- a/apps/server/AliasVault.Api/Controllers/Abstracts/AuthenticatedRequestController.cs
+++ b/apps/server/AliasVault.Api/Controllers/Abstracts/AuthenticatedRequestController.cs
@@ -26,7 +26,7 @@ public abstract class AuthenticatedRequestController(UserManager<AliasVaultUser>
/// <summary>
/// Gets the raw client header the current request arrived with.
/// </summary>
- protected string? ClientHeader => Request.Headers[ClientHeaderInfo.HeaderName].FirstOrDefault();
+ protected string? ClientHeader => ClientHeaderInfo.GetRawValue(Request);
/// <summary>
/// Get the userManager instance.
diff --git a/apps/server/AliasVault.Api/Controllers/V1/AuthController.cs b/apps/server/AliasVault.Api/Controllers/V1/AuthController.cs
index 6d91cfc6a..39a9efb7c 100644
--- a/apps/server/AliasVault.Api/Controllers/V1/AuthController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V1/AuthController.cs
@@ -78,11 +78,10 @@ public class AuthController(IAliasServerDbContextFactory dbContextFactory, UserM
/// <summary>
/// Status endpoint called by client to check if user is still authenticated and get sync status.
/// </summary>
- /// <param name="clientHeader">Client header.</param>
/// <returns>Returns status response if valid authentication is provided, otherwise it will return 401 unauthorized.</returns>
[Authorize]
[HttpGet("status")]
- public async Task<IActionResult> Status([FromHeader(Name = "X-AliasVault-Client")] string? clientHeader)
+ public async Task<IActionResult> Status()
{
var user = await userManager.GetUserAsync(User);
if (user == null)
@@ -105,7 +104,7 @@ public class AuthController(IAliasServerDbContextFactory dbContextFactory, UserM
// Check client version compatibility if header is provided
var clientSupported = false;
- var clientInfo = ClientHeaderInfo.Parse(clientHeader);
+ var clientInfo = ClientHeaderInfo.Parse(ClientHeaderInfo.GetRawValue(Request));
if (!string.IsNullOrEmpty(clientInfo.ClientVersion)
&& AppInfo.MinimumClientVersions.TryGetValue(clientInfo.ClientName, out var minimumVersion))
{
diff --git a/apps/server/AliasVault.Api/Controllers/V1/VaultController.cs b/apps/server/AliasVault.Api/Controllers/V1/VaultController.cs
index 991c99abb..bf1954057 100644
--- a/apps/server/AliasVault.Api/Controllers/V1/VaultController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V1/VaultController.cs
@@ -136,10 +136,9 @@ public class VaultController(ILogger<VaultController> logger, IAliasServerDbCont
/// Save a new vault to the database for the current user.
/// </summary>
/// <param name="model">Vault model.</param>
- /// <param name="clientHeader">Client header.</param>
/// <returns>IActionResult.</returns>
[HttpPost("")]
- public async Task<IActionResult> Update([FromBody] Shared.Models.WebApi.V1.Vault.Vault model, [FromHeader(Name = "X-AliasVault-Client")] string? clientHeader)
+ public async Task<IActionResult> Update([FromBody] Shared.Models.WebApi.V1.Vault.Vault model)
{
await using var context = await dbContextFactory.CreateDbContextAsync();
@@ -195,7 +194,7 @@ public class VaultController(ILogger<VaultController> logger, IAliasServerDbCont
currentManifest.FileSize = FileHelper.Base64StringToKilobytes(model.Blob);
currentManifest.CredentialsCount = model.CredentialsCount;
currentManifest.EmailClaimsCount = model.EmailAddressList.Count;
- currentManifest.Client = clientHeader;
+ currentManifest.Client = ClientHeader;
currentManifest.CreatedAt = timeProvider.UtcNow;
currentManifest.UpdatedAt = timeProvider.UtcNow;
@@ -222,12 +221,9 @@ public class VaultController(ILogger<VaultController> logger, IAliasServerDbCont
/// Save a new vault to the database based on a new encryption password for the current user.
/// </summary>
/// <param name="model">Vault model.</param>
- /// <param name="clientHeader">Client header.</param>
/// <returns>IActionResult.</returns>
[HttpPost("change-password")]
- public async Task<IActionResult> UpdateChangePassword(
- [FromBody] VaultPasswordChangeRequest model,
- [FromHeader(Name = "X-AliasVault-Client")] string? clientHeader)
+ public async Task<IActionResult> UpdateChangePassword([FromBody] VaultPasswordChangeRequest model)
{
await using var context = await dbContextFactory.CreateDbContextAsync();
@@ -300,7 +296,7 @@ public class VaultController(ILogger<VaultController> logger, IAliasServerDbCont
currentManifest.Verifier = model.NewPasswordVerifier;
currentManifest.EncryptionType = Defaults.EncryptionType;
currentManifest.EncryptionSettings = Defaults.EncryptionSettings;
- currentManifest.Client = clientHeader;
+ currentManifest.Client = ClientHeader;
currentManifest.CreatedAt = timeProvider.UtcNow;
currentManifest.UpdatedAt = timeProvider.UtcNow;
diff --git a/apps/server/AliasVault.Api/Controllers/V2/StatusController.cs b/apps/server/AliasVault.Api/Controllers/V2/StatusController.cs
index c578aac90..2e998b928 100644
--- a/apps/server/AliasVault.Api/Controllers/V2/StatusController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V2/StatusController.cs
@@ -35,10 +35,9 @@ public class StatusController(IAliasServerDbContextFactory dbContextFactory, Use
/// <summary>
/// Status endpoint called by the client to get the full sync status in one call.
/// </summary>
- /// <param name="clientHeader">Client header used for version-compatibility checks.</param>
/// <returns>The combined status response, or 401 when the caller is not authenticated.</returns>
[HttpGet]
- public async Task<IActionResult> Status([FromHeader(Name = "X-AliasVault-Client")] string? clientHeader)
+ public async Task<IActionResult> Status()
{
var user = await GetUserManager().GetUserAsync(User);
if (user == null)
@@ -70,7 +69,7 @@ public class StatusController(IAliasServerDbContextFactory dbContextFactory, Use
// Check client version compatibility if the header is provided.
var clientSupported = false;
- var clientInfo = ClientHeaderInfo.Parse(clientHeader);
+ var clientInfo = ClientHeaderInfo.Parse(ClientHeader);
if (!string.IsNullOrEmpty(clientInfo.ClientVersion)
&& AppInfo.MinimumClientVersions.TryGetValue(clientInfo.ClientName, out var minimumVersion))
{
@@ -87,7 +86,7 @@ public class StatusController(IAliasServerDbContextFactory dbContextFactory, Use
ManifestRevisions = manifestRevisions,
PersonalManifestId = personalManifestId,
BucketRevisions = bucketRevisions,
- Capabilities = await capabilityService.GetCapabilitiesAsync(user.Id, clientHeader),
+ Capabilities = await capabilityService.GetCapabilitiesAsync(user.Id, ClientHeader),
PendingActions = await ClientActionHelper.GetPendingActionsAsync(context, user.Id),
});
}
diff --git a/apps/server/AliasVault.Api/Controllers/V2/VaultController.cs b/apps/server/AliasVault.Api/Controllers/V2/VaultController.cs
index a3c15db03..11a992b32 100644
--- a/apps/server/AliasVault.Api/Controllers/V2/VaultController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V2/VaultController.cs
@@ -244,10 +244,9 @@ public class VaultController(
/// buckets, and new blobs in a single all-or-nothing DB transaction.
/// </summary>
/// <param name="model">Vault write request DTO.</param>
- /// <param name="clientHeader">Client header.</param>
/// <returns>Vault write response DTO.</returns>
[HttpPost("")]
- public async Task<IActionResult> Write([FromBody] VaultWriteRequest model, [FromHeader(Name = "X-AliasVault-Client")] string? clientHeader)
+ public async Task<IActionResult> Write([FromBody] VaultWriteRequest model)
{
await using var context = await dbContextFactory.CreateDbContextAsync();
var user = await GetCurrentUserAsync();
@@ -439,7 +438,7 @@ public class VaultController(
row.RevisionNumber = mw.CurrentRevision + 1;
row.FileSize = FileHelper.BytesToKilobytes(row.ManifestBlob.Length);
row.CredentialsCount = mw.CredentialsCount;
- row.Client = clientHeader;
+ row.Client = ClientHeader;
row.UpdatedAt = timeProvider.UtcNow;
// Every manifest counts the aliases the push filed against it, shared manifests included. One
diff --git a/apps/server/AliasVault.Api/Filters/RequireCapabilityAttribute.cs b/apps/server/AliasVault.Api/Filters/RequireCapabilityAttribute.cs
index 2ab9e5192..eab9fa27a 100644
--- a/apps/server/AliasVault.Api/Filters/RequireCapabilityAttribute.cs
+++ b/apps/server/AliasVault.Api/Filters/RequireCapabilityAttribute.cs
@@ -34,7 +34,7 @@ public sealed class RequireCapabilityAttribute(string capabilityKey) : Attribute
}
var capabilityService = context.HttpContext.RequestServices.GetRequiredService<CapabilityService>();
- var clientHeader = context.HttpContext.Request.Headers[ClientHeaderInfo.HeaderName].FirstOrDefault();
+ var clientHeader = ClientHeaderInfo.GetRawValue(context.HttpContext.Request);
if (await capabilityService.IsEnabledAsync(userId, capabilityKey, clientHeader))
{
return;
diff --git a/apps/server/AliasVault.Api/Headers/ClientHeaderInfo.cs b/apps/server/AliasVault.Api/Headers/ClientHeaderInfo.cs
index da0a4bce2..8e10d3912 100644
--- a/apps/server/AliasVault.Api/Headers/ClientHeaderInfo.cs
+++ b/apps/server/AliasVault.Api/Headers/ClientHeaderInfo.cs
@@ -7,6 +7,8 @@
namespace AliasVault.Api.Headers;
+using Microsoft.AspNetCore.Http;
+
/// <summary>
/// Parsed components of the X-AliasVault-Client request header.
///
@@ -22,6 +24,13 @@ public sealed record ClientHeaderInfo(string ClientName, string? ClientVersion)
/// </summary>
public const string HeaderName = "X-AliasVault-Client";
+ /// <summary>
+ /// Read the raw client header off a request.
+ /// </summary>
+ /// <param name="request">The incoming request.</param>
+ /// <returns>The raw header value, or null when the request did not carry one.</returns>
+ public static string? GetRawValue(HttpRequest request) => request.Headers[HeaderName].FirstOrDefault();
+
/// <summary>
/// Parse a raw X-AliasVault-Client header value into its components.
/// </summary>