Skip to content

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

Add max batch limits to API v2

Leendert de Borst95d7f447585e
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/Blob.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/Blob.cs
index 721900fc9..fffb5792e 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/Blob.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/Blob.cs
@@ -15,9 +15,11 @@ using System.ComponentModel.DataAnnotations;
public class Blob
{
/// <summary>Gets or sets the per-manifest salted SHA-256 hex of the plaintext.</summary>
+ [RegularExpression(VaultWriteLimits.HashPattern)]
public required string Hash { get; set; }
/// <summary>Gets or sets the blob category ("favicon" or "attachment").</summary>
+ [StringLength(VaultWriteLimits.MaxCategoryLength, MinimumLength = 1)]
public required string Category { get; set; }
/// <summary>Gets or sets the bytes encrypted with the blob's own key, base64-encoded for transport.</summary>
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobHashesRequest.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobHashesRequest.cs
index 881d90dc9..8910188aa 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobHashesRequest.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobHashesRequest.cs
@@ -7,6 +7,8 @@
namespace AliasVault.Shared.Models.WebApi.V2.Vault;
+using System.ComponentModel.DataAnnotations;
+
/// <summary>
/// A list of blob hashes, sent as a POST body (not a query string) because a vault can reference hundreds of
/// blobs and 64-char hex hashes would exceed URL length limits. Used by POST /v2/Vault/blobs/missing and
@@ -18,5 +20,6 @@ public class BlobHashesRequest
public required Guid ManifestId { get; set; }
/// <summary>Gets or sets the per-manifest salted SHA-256 hex hashes.</summary>
+ [MaxLength(VaultWriteLimits.MaxHashesPerRequest)]
public required List<string> Hashes { get; set; }
}
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobReference.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobReference.cs
index 6bfebaaaf..ef6aebc85 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobReference.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobReference.cs
@@ -7,15 +7,19 @@
namespace AliasVault.Shared.Models.WebApi.V2.Vault;
+using System.ComponentModel.DataAnnotations;
+
/// <summary>
/// A reference to a content-addressed blob held in VaultBlobObjects.
/// </summary>
public class BlobReference
{
/// <summary>Gets or sets the per-manifest salted SHA-256 hex of the plaintext.</summary>
+ [RegularExpression(VaultWriteLimits.HashPattern)]
public required string Hash { get; set; }
/// <summary>Gets or sets the blob category (e.g. "favicon" or "attachment").</summary>
+ [StringLength(VaultWriteLimits.MaxCategoryLength, MinimumLength = 1)]
public required string Category { get; set; }
/// <summary>
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobUploadRequest.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobUploadRequest.cs
index 0016b9133..1d3a57479 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobUploadRequest.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/BlobUploadRequest.cs
@@ -7,6 +7,8 @@
namespace AliasVault.Shared.Models.WebApi.V2.Vault;
+using System.ComponentModel.DataAnnotations;
+
/// <summary>
/// POST /v2/Vault/blobs. Batch-upload encrypted blobs ahead of a manifest upload. Idempotent per blob on
/// (manifest, hash). Clients chunk large blob sets across multiple calls to keep request bodies within server limits.
@@ -17,6 +19,7 @@ public class BlobUploadRequest
public required Guid ManifestId { get; set; }
/// <summary>Gets or sets the encrypted blobs to store.</summary>
+ [MaxLength(VaultWriteLimits.MaxBlobsPerUpload)]
public required List<Blob> Blobs { get; set; }
/// <summary>Gets or sets a value indicating whether existing blobs with the same hash must have their ciphertext
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ClaimedEmailAddress.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ClaimedEmailAddress.cs
index 9e072a86f..6473ed249 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ClaimedEmailAddress.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ClaimedEmailAddress.cs
@@ -7,12 +7,15 @@
namespace AliasVault.Shared.Models.WebApi.V2.Vault;
+using System.ComponentModel.DataAnnotations;
+
/// <summary>
/// An email alias the client claims, together with the manifest holding the item it belongs to.
/// </summary>
public class ClaimedEmailAddress
{
/// <summary>Gets or sets the full email address.</summary>
+ [StringLength(255, MinimumLength = 3)]
public required string Address { get; set; }
/// <summary>Gets or sets the manifest whose key encrypts mail for this address.</summary>
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/EmailRoutingPush.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/EmailRoutingPush.cs
index 8b2946d4e..a0556ea6e 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/EmailRoutingPush.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/EmailRoutingPush.cs
@@ -7,6 +7,8 @@
namespace AliasVault.Shared.Models.WebApi.V2.Vault;
+using System.ComponentModel.DataAnnotations;
+
/// <summary>
/// The email-routing set a vault push uploads: every alias the client wants routed, each carrying the manifest
/// that owns it. Aliases missing from a push are disabled, so a push always carries the complete set of the
@@ -18,17 +20,20 @@ public class EmailRoutingPush
/// Gets or sets the claimed addresses, each with the manifest whose key encrypts its mail. The manifest ids
/// are a request, not a grant: the server validates each against what the caller may claim for.
/// </summary>
+ [MaxLength(VaultWriteLimits.MaxClaimedAddressesPerPush)]
public List<ClaimedEmailAddress> EmailAddressList { get; set; } = [];
/// <summary>
/// Gets or sets the manifests this push speaks for: every manifest the client opened to build the address list
/// above, whether or not it holds any alias.
/// </summary>
+ [MaxLength(VaultWriteLimits.MaxManifestsPerWrite)]
public List<Guid> CoveredManifestIds { get; set; } = [];
/// <summary>
/// Gets or sets the revision of each covered manifest the address list was built from. The write is rejected as
/// outdated when any of them is behind the server.
/// </summary>
+ [MaxLength(VaultWriteLimits.MaxManifestsPerWrite)]
public required List<ManifestRevision> BaseRevisions { get; set; }
}
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ManifestWrite.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ManifestWrite.cs
index ea6bedefe..24f0703e5 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ManifestWrite.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/ManifestWrite.cs
@@ -31,6 +31,7 @@ public class ManifestWrite
/// <summary>Gets or sets the complete list of blob hashes this manifest revision references. The server validates
/// each exists (in the caller's store for their personal manifest; in any member's store for a shared manifest) before committing.</summary>
+ [MaxLength(VaultWriteLimits.MaxBlobReferencesPerManifest)]
public List<BlobReference> BlobReferences { get; set; } = [];
/// <summary>
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/VaultWriteLimits.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/VaultWriteLimits.cs
new file mode 100644
index 000000000..6e7cda605
--- /dev/null
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/VaultWriteLimits.cs
@@ -0,0 +1,39 @@
+//-----------------------------------------------------------------------
+// <copyright file="VaultWriteLimits.cs" company="aliasvault">
+// Copyright (c) aliasvault. All rights reserved.
+// Licensed under the AGPLv3 license. See LICENSE.md file in the project root for full license information.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace AliasVault.Shared.Models.WebApi.V2.Vault;
+
+/// <summary>
+/// Request caps on the v2 vault write surface. These are part of the API contract: clients batch against the
+/// per-request caps.
+/// </summary>
+public static class VaultWriteLimits
+{
+ /// <summary>The most manifests one write may touch, and the most a routing push may cover or name a base revision for.</summary>
+ public const int MaxManifestsPerWrite = 32;
+
+ /// <summary>The most data buckets one write may touch (every bucket kind of every manifest).</summary>
+ public const int MaxBucketsPerWrite = 64;
+
+ /// <summary>The most blobs one manifest revision may reference. A sanity bound, not a batching cap: the list is complete per revision.</summary>
+ public const int MaxBlobReferencesPerManifest = 25_000;
+
+ /// <summary>The most claimed addresses one routing push may carry. A sanity bound, not a batching cap: the list is complete per covered manifest.</summary>
+ public const int MaxClaimedAddressesPerPush = 10_000;
+
+ /// <summary>The most blobs one upload request may carry; clients split larger sets into several requests.</summary>
+ public const int MaxBlobsPerUpload = 100;
+
+ /// <summary>The most hashes one missing-check or download request may name; clients split larger sets into several requests.</summary>
+ public const int MaxHashesPerRequest = 1000;
+
+ /// <summary>The most characters a blob category token may have (matches the column width).</summary>
+ public const int MaxCategoryLength = 20;
+
+ /// <summary>A blob hash: SHA-256 as 64 lowercase hex characters.</summary>
+ public const string HashPattern = "^[0-9a-f]{64}$";
+}
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/VaultWriteRequest.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/VaultWriteRequest.cs
index 99ae0c6f9..f72860cf4 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/VaultWriteRequest.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Vault/VaultWriteRequest.cs
@@ -7,6 +7,7 @@
namespace AliasVault.Shared.Models.WebApi.V2.Vault;
+using System.ComponentModel.DataAnnotations;
using System.Text.Json.Serialization;
/// <summary>
@@ -18,9 +19,11 @@ public class VaultWriteRequest
public required string Username { get; set; }
/// <summary>Gets or sets the manifests to write.</summary>
+ [MaxLength(VaultWriteLimits.MaxManifestsPerWrite)]
public List<ManifestWrite> Manifests { get; set; } = [];
/// <summary>Gets or sets the data buckets to upsert.</summary>
+ [MaxLength(VaultWriteLimits.MaxBucketsPerWrite)]
public List<BucketWrite> Buckets { get; set; } = [];
/// <summary>Gets or sets the email routing data to update server-side.</summary>
diff --git a/core/rust/src/vault_sync/http.rs b/core/rust/src/vault_sync/http.rs
index 517dd02aa..867978f10 100644
--- a/core/rust/src/vault_sync/http.rs
+++ b/core/rust/src/vault_sync/http.rs
@@ -79,9 +79,12 @@ pub(crate) const VAULT_KEY_PASSWORD_ENDPOINT: &str = "VaultKey/Password";
/// Max base64 characters in one blob transfer request or response body.
pub(crate) const BLOB_TRANSFER_BATCH_MAX_CHARS: usize = 4 * 1024 * 1024;
-/// Upper bound on the number of blobs in one transfer batch.
+/// Upper bound on the number of blobs in one transfer batch (the server's `VaultWriteLimits.MaxBlobsPerUpload`).
pub(crate) const BLOB_TRANSFER_BATCH_MAX_COUNT: usize = 100;
+/// Upper bound on the number of hashes in one `blobs/missing` or `blobs/download` request (the server's `VaultWriteLimits.MaxHashesPerRequest`).
+pub(crate) const BLOB_HASH_REQUEST_MAX_COUNT: usize = 1000;
+
/// Split items into transfer batches bounded by both blob transfer limits.
pub(crate) fn batch_by_transfer_cost<T>(items: Vec<T>, cost_of: impl Fn(&T) -> usize) -> Vec<Vec<T>> {
let mut batches = Vec::new();