Consumer API: Make File's Owner and OwnerSignature required (#503)

* Change Base64 strings to byte arrays in DTO * Make non-null fields required in data classes * Add PropertyGroup Nullable to File projects * Remove call to deleted script * Make Owner and OwnerSignature required, validate it correctly * Make DeletedBy null in response * Add DB migration to make Owner property non-null with default value of "" * Fix Schroedinger's Whitespace (File was not completely CRLF) * Make OwnerSignature, CipherHash and EncryptedProperties base64 strings again * Remove trailing whitespace
nmshd · Jan 26, 2024 · c2d56fc · c2d56fc
1 parent 1ca8f29
commit c2d56fc
Show file tree

Hide file tree

Showing 17 changed files with 380 additions and 39 deletions.
diff --git a/Modules/Files/src/Files.Application/Files.Application.csproj b/Modules/Files/src/Files.Application/Files.Application.csproj
@@ -1,4 +1,8 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+	  <Nullable>enable</Nullable>
+	</PropertyGroup>
 
 	<ItemGroup>
 		<PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.1" />

diff --git a/Modules/Files/src/Files.Application/Files/Commands/CreateFile/CreateFileCommand.cs b/Modules/Files/src/Files.Application/Files/Commands/CreateFile/CreateFileCommand.cs
@@ -7,14 +7,14 @@ namespace Backbone.Modules.Files.Application.Files.Commands.CreateFile;
 [ApplyQuotasForMetrics("NumberOfFiles", "UsedFileStorageSpace")]
 public class CreateFileCommand : IRequest<CreateFileResponse>
 {
-    public byte[] FileContent { get; set; }
+    public required byte[] FileContent { get; set; }
 
-    public IdentityAddress Owner { get; set; }
-    public byte[] OwnerSignature { get; set; }
+    public required IdentityAddress Owner { get; set; }
+    public required byte[] OwnerSignature { get; set; }
 
-    public byte[] CipherHash { get; set; }
+    public required byte[] CipherHash { get; set; }
 
-    public DateTime ExpiresAt { get; set; }
+    public required DateTime ExpiresAt { get; set; }
 
-    public byte[] EncryptedProperties { get; set; }
+    public required byte[] EncryptedProperties { get; set; }
 }
diff --git a/Modules/Files/src/Files.Application/Files/Commands/CreateFile/CreateFileCommandValidator.cs b/Modules/Files/src/Files.Application/Files/Commands/CreateFile/CreateFileCommandValidator.cs
@@ -23,12 +23,10 @@ public CreateFileCommandValidator()
             .GreaterThan(SystemTime.UtcNow).WithMessage("'{PropertyName}' must be in the future.").WithErrorCode(GenericApplicationErrors.Validation.InvalidPropertyValue().Code);
 
         RuleFor(m => m.Owner)
-            .NotEmpty()
-            .When(m => m.OwnerSignature is { Length: > 0 })
-            .WithMessage(m => $"{nameof(m.Owner)} and {nameof(m.OwnerSignature)} have to be provided either both or none.");
+            .DetailedNotEmpty();
 
         RuleFor(m => m.OwnerSignature)
-            .NumberOfBytes(0, 512);
+            .NumberOfBytes(1, 512);
 
         RuleFor(r => r.EncryptedProperties)
             .NumberOfBytes(0, 1.Mebibytes());

diff --git a/Modules/Files/src/Files.Application/Files/Commands/CreateFile/CreateFileResponse.cs b/Modules/Files/src/Files.Application/Files/Commands/CreateFile/CreateFileResponse.cs
@@ -8,24 +8,24 @@ namespace Backbone.Modules.Files.Application.Files.Commands.CreateFile;
 
 public class CreateFileResponse : IHaveCustomMapping
 {
-    public FileId Id { get; set; }
+    public required FileId Id { get; set; }
 
-    public DateTime CreatedAt { get; set; }
-    public IdentityAddress CreatedBy { get; set; }
-    public DeviceId CreatedByDevice { get; set; }
+    public required DateTime CreatedAt { get; set; }
+    public required IdentityAddress CreatedBy { get; set; }
+    public required DeviceId CreatedByDevice { get; set; }
 
-    public DateTime ModifiedAt { get; set; }
-    public IdentityAddress ModifiedBy { get; set; }
+    public required DateTime ModifiedAt { get; set; }
+    public required IdentityAddress ModifiedBy { get; set; }
     public DateTime? DeletedAt { get; set; }
-    public IdentityAddress DeletedBy { get; set; }
+    public IdentityAddress? DeletedBy { get; set; }
 
-    public IdentityAddress Owner { get; set; }
-    public byte[] OwnerSignature { get; set; }
+    public required IdentityAddress Owner { get; set; }
+    public required byte[] OwnerSignature { get; set; }
 
-    public long CipherSize { get; set; }
-    public byte[] CipherHash { get; set; }
+    public required long CipherSize { get; set; }
+    public required byte[] CipherHash { get; set; }
 
-    public DateTime ExpiresAt { get; set; }
+    public required DateTime ExpiresAt { get; set; }
 
     public void CreateMappings(Profile configuration)
     {

diff --git a/Modules/Files/src/Files.Application/Files/Commands/CreateFile/Handler.cs b/Modules/Files/src/Files.Application/Files/Commands/CreateFile/Handler.cs
@@ -29,7 +29,7 @@ public async Task<CreateFileResponse> Handle(CreateFileCommand request, Cancella
             _userContext.GetAddress(),
             _userContext.GetDeviceId(),
             request.Owner,
-            request.OwnerSignature ?? Array.Empty<byte>(),
+            request.OwnerSignature,
             request.CipherHash,
             request.FileContent,
             request.FileContent.LongLength,

diff --git a/Modules/Files/src/Files.ConsumerApi/Controllers/FilesController.cs b/Modules/Files/src/Files.ConsumerApi/Controllers/FilesController.cs
@@ -49,7 +49,7 @@ public async Task<IActionResult> UploadFile([FromForm] CreateFileDTO dto, Cancel
             ExpiresAt = dto.ExpiresAt,
             CipherHash = UrlBase64.Decode(dto.CipherHash),
             Owner = dto.Owner,
-            OwnerSignature = dto.OwnerSignature == null ? null : UrlBase64.Decode(dto.OwnerSignature),
+            OwnerSignature = UrlBase64.Decode(dto.OwnerSignature),
             EncryptedProperties = UrlBase64.Decode(dto.EncryptedProperties)
         };
 

diff --git a/Modules/Files/src/Files.ConsumerApi/DTOs/CreateFileDTO.cs b/Modules/Files/src/Files.ConsumerApi/DTOs/CreateFileDTO.cs
@@ -5,13 +5,13 @@ namespace Backbone.Modules.Files.ConsumerApi.DTOs;
 
 public class CreateFileDTO
 {
-    public IFormFile Content { get; set; }
-    public IdentityAddress? Owner { get; set; }
-    public string? OwnerSignature { get; set; }
+    public required IFormFile Content { get; set; }
+    public required IdentityAddress Owner { get; set; }
+    public required string OwnerSignature { get; set; }
 
-    public string CipherHash { get; set; }
+    public required string CipherHash { get; set; }
 
-    public DateTime ExpiresAt { get; set; }
+    public required DateTime ExpiresAt { get; set; }
 
-    public string EncryptedProperties { get; set; }
+    public required string EncryptedProperties { get; set; }
 }
diff --git a/Modules/Files/src/Files.Domain/Entities/File.cs b/Modules/Files/src/Files.Domain/Entities/File.cs
@@ -45,7 +45,7 @@ public File(IdentityAddress createdBy, DeviceId createdByDevice, IdentityAddress
     public IdentityAddress? DeletedBy { get; set; }
     public DeviceId? DeletedByDevice { get; set; }
 
-    public IdentityAddress? Owner { get; set; }
+    public IdentityAddress Owner { get; set; }
     public byte[] OwnerSignature { get; set; }
 
     public long CipherSize { get; set; }

diff --git a/....Database.Postgres/Migrations/20240124085123_SetOwnerRequiredWithDefaultValue.Designer.cs b/....Database.Postgres/Migrations/20240124085123_SetOwnerRequiredWithDefaultValue.Designer.cs
diff --git a/...structure.Database.Postgres/Migrations/20240124085123_SetOwnerRequiredWithDefaultValue.cs b/...structure.Database.Postgres/Migrations/20240124085123_SetOwnerRequiredWithDefaultValue.cs
@@ -0,0 +1,48 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace Backbone.Modules.Files.Infrastructure.Database.Postgres.Migrations
+{
+    /// <inheritdoc />
+    public partial class SetOwnerRequiredWithDefaultValue : Migration
+    {
+        /// <inheritdoc />
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AlterColumn<string>(
+                name: "Owner",
+                table: "FileMetadata",
+                type: "character(36)",
+                unicode: false,
+                fixedLength: true,
+                maxLength: 36,
+                nullable: false,
+                defaultValue: "",
+                oldClrType: typeof(string),
+                oldType: "character(36)",
+                oldUnicode: false,
+                oldFixedLength: true,
+                oldMaxLength: 36,
+                oldNullable: true);
+        }
+
+        /// <inheritdoc />
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AlterColumn<string>(
+                name: "Owner",
+                table: "FileMetadata",
+                type: "character(36)",
+                unicode: false,
+                fixedLength: true,
+                maxLength: 36,
+                nullable: true,
+                oldClrType: typeof(string),
+                oldType: "character(36)",
+                oldUnicode: false,
+                oldFixedLength: true,
+                oldMaxLength: 36);
+        }
+    }
+}
diff --git a/...iles/src/Files.Infrastructure.Database.Postgres/Migrations/FilesDbContextModelSnapshot.cs b/...iles/src/Files.Infrastructure.Database.Postgres/Migrations/FilesDbContextModelSnapshot.cs
@@ -17,7 +17,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
         {
 #pragma warning disable 612, 618
             modelBuilder
-                .HasAnnotation("ProductVersion", "7.0.5")
+                .HasAnnotation("ProductVersion", "8.0.0")
                 .HasAnnotation("Relational:MaxIdentifierLength", 63);
 
             NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
@@ -94,6 +94,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                         .IsFixedLength();
 
                     b.Property<string>("Owner")
+                        .IsRequired()
                         .HasMaxLength(36)
                         .IsUnicode(false)
                         .HasColumnType("character(36)")