Credential Tagging Implementation

.gitignore

@@ -349,3 +349,6 @@ Vault/wwwroot/js/dist/
 
 # Development settings
 appsettings.Development.json
+
+# Database releases
+!db/releases

Vault.ruleset

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<RuleSet Name="Vault" ToolsVersion="16.0">
-  <Rules AnalyzerId="Microsoft.CodeAnalysis.NetAnalyzers" RuleNamespace="Microsoft.CodeAnalysis.NetAnalyzers">
-    <Rule Id="CA1014" Action="None" />
+<RuleSet Name="Vault" ToolsVersion="17.0">
+  <Rules AnalyzerId="Microsoft.CodeAnalysis.CSharp.Features" RuleNamespace="Microsoft.CodeAnalysis.CSharp.Features">
+    <Rule Id="IDE0290" Action="None" />
   </Rules>
   <Rules AnalyzerId="Microsoft.CodeQuality.Analyzers" RuleNamespace="Microsoft.CodeQuality.Analyzers">
     <Rule Id="CA2007" Action="None" />

Vault/Controllers/CredentialsController.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Threading.Tasks;
 using Dapper;
 using Microsoft.AspNetCore.Mvc;
@@ -14,12 +16,45 @@ public class CredentialsController : Controller
         public CredentialsController(IConnectionFactory cf) =>
             _db = new SqlExecutor(cf);
 
+        public async Task<ActionResult> ReadTagIndex(string userId) =>
+            await _db.ResultAsJson(async conn => {
+                var reader = await conn.QueryMultipleAsync(SqlStatements.TagIndex, new { UserID = userId });
+
+                var tags = await reader.ReadAsync<(string TagID, string Label)>();
+                var index = await reader.ReadAsync<(string TagID, string CredentialID)>();
+
+                return new {
+                    tags = tags.Select(t => new {
+                        t.TagID,
+                        t.Label,
+                    }),
+                    index = index
+                        .GroupBy(i => i.TagID)
+                        .ToDictionary(g => g.Key, g => g.Select(i => i.CredentialID))
+                };
+            });
+
         [HttpPost]
         public async Task<ActionResult> Create([FromBody] Credential model) =>
-            await _db.ResultAsJson(conn => conn.ExecuteAsync(SqlStatements.Insert, model.WithNewID()));
+            await _db.ResultAsJson(async conn => {
+                var c = model.WithNewID();
+                var a = await conn.ExecuteAsync(SqlStatements.Insert, c);
+                var b = await conn.ExecuteAsync(SqlStatements.TagsToCredential, c.TagArray);
+                return a + b;
+            });
 
         public async Task<ActionResult> Read(string id) =>
-            await _db.ResultAsJson(conn => conn.QuerySingleOrDefaultAsync<Credential>(SqlStatements.SelectSingle, new { CredentialID = id }));
+            await _db.ResultAsJson(async conn => {
+                var reader = await conn.QueryMultipleAsync(SqlStatements.SelectSingle, new { CredentialID = id });
+
+                var credential = await reader.ReadSingleAsync<Credential>();
+                var tags = await reader.ReadAsync<(string TagID, string Label)>();
+
+                credential.Tags = string.Join('|', tags.Select(t => t.TagID));
+                credential.TagDisplay = string.Join('|', tags.Select(t => t.Label));
+
+                return credential;
+            });
 
         public async Task<ActionResult> ReadAll(string userId) =>
             await _db.ResultAsJson(conn => conn.QueryAsync<Credential>(SqlStatements.Select, new { UserID = userId }));
@@ -29,7 +64,12 @@ public async Task<ActionResult> ReadSummaries(string userId) =>
 
         [HttpPost]
         public async Task<ActionResult> Update([FromBody] Credential model) =>
-            await _db.ResultAsJson(conn => conn.ExecuteAsync(SqlStatements.Update, model));
+            await _db.ResultAsJson(async conn => {
+                var a = await conn.ExecuteAsync(SqlStatements.Update, model);
+                var b = await conn.ExecuteAsync(SqlStatements.DeleteTagsFromCredential, model);
+                var c = await conn.ExecuteAsync(SqlStatements.TagsToCredential, model.TagArray);
+                return a + b + c;
+            });
 
         [HttpPost]
         public async Task<ActionResult> Import([FromBody] ImportViewModel model) =>

Vault/Models/Credential.cs

@@ -1,5 +1,6 @@
 using System;
 using System.ComponentModel;
+using System.Linq;
 
 namespace Vault.Models
 {
@@ -19,6 +20,7 @@ public Credential()
             UserDefined2 = "{{UserDefined2}}";
             Notes = "{{Notes}}";
             PwdOptions = "{{PwdOptions}}";
+            Tags = "{{Tags}}";
         }
 
         public string CredentialID { get; set; }
@@ -50,6 +52,15 @@ public Credential()
 
         public string PwdOptions { get; set; }
 
+        public string Tags { get; set; }
+
+        public string TagDisplay { get; set; }
+
+        public object[] TagArray =>
+            Tags?
+                .Split('|', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries)
+                .Select(t => new { TagID = t, CredentialID }).ToArray() ?? [];
+
         public Credential WithNewID()
         {
             var credentialWithGuid = (Credential)MemberwiseClone();

Vault/Models/CredentialSummary.cs

@@ -4,8 +4,6 @@ public class CredentialSummary
     {
         public string CredentialID { get; set; }
 
-        public string UserID { get; set; }
-
         public string Description { get; set; }
 
         public string Username { get; set; }

Vault/Models/DatabaseType.cs

@@ -0,0 +1,13 @@
+namespace Vault.Models
+{
+#pragma warning disable SA1602 // Enumeration items should be documented
+    public enum DatabaseType
+    {
+        Unknown,
+
+        SQLite,
+
+        SqlServer
+    }
+#pragma warning restore SA1602 // Enumeration items should be documented
+}

Vault/Models/LoginResult.cs

@@ -6,7 +6,7 @@ public LoginResult(string userID) =>
             UserID = userID;
 
         public static LoginResult Failed =>
-            new (null);
+            new(null);
 
         public string UserID { get; }
 

Vault/Startup.cs

@@ -7,6 +7,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Newtonsoft.Json.Serialization;
+using Vault.Models;
 using Vault.Support;
 
 namespace Vault
@@ -32,9 +33,11 @@ public void ConfigureServices(IServiceCollection services)
 
             services.AddMvc(options => options.Filters.Add<ProtectWithSecurityKeyFilter>());
 
+            SqlStatements.DatabaseType = Configuration["DbType"] == "SQLite" ? DatabaseType.SQLite : DatabaseType.SqlServer;
+
             var connectionString = Configuration.GetConnectionString("Main");
 
-            var connectionFactory = Configuration["DbType"] == "SQLite"
+            var connectionFactory = SqlStatements.DatabaseType == DatabaseType.SQLite
                 ? new Func<IServiceProvider, IConnectionFactory>(_ => new SQLiteConnectionFactory(connectionString))
                 : _ => new SqlConnectionFactory(connectionString);
 

Vault/Support/InlineJsGlobalSerializer.cs

@@ -10,7 +10,7 @@ namespace Vault.Support
     public static class InlineJsGlobalSerializer
     {
         private static readonly JsonSerializerSettings _settings =
-            new () {
+            new() {
                 NullValueHandling = NullValueHandling.Ignore,
                 ContractResolver = new DefaultContractResolver {
                     NamingStrategy = new CamelCaseNamingStrategy()
@@ -40,7 +40,7 @@ public static string AsJson(this object o)
         }
 
         private static JsonTextWriter GetJsonWriter(StringWriter sw) =>
-            new (sw) {
+            new(sw) {
                 Formatting = Formatting.Indented,
                 IndentChar = ' ',
                 Indentation = 4,

Vault/Support/SqlStatements.cs

@@ -1,11 +1,13 @@
-namespace Vault.Support
+using System;
+using Vault.Models;
+
+namespace Vault.Support
 {
     public static class SqlStatements
     {
         public const string SelectSummary =
             @"SELECT
                   CredentialID,
-                  UserID,
                   Description,
                   Username,
                   Password,
@@ -19,38 +21,60 @@ public static class SqlStatements
             "SELECT * FROM Credentials WHERE UserID = @UserID";
 
         public const string SelectSingle =
-            "SELECT * FROM Credentials WHERE CredentialID = @CredentialID";
+            """
+            SELECT
+                *
+            FROM
+                Credentials
+            WHERE
+                CredentialID = @CredentialID;
+
+            SELECT
+                tc.TagID,
+                t.Label
+            FROM
+                Tags_Credentials tc
+            INNER JOIN
+                Tags t
+                    ON t.TagID = tc.TagID
+            WHERE
+                tc.CredentialID = @CredentialID
+            ORDER BY
+                t.Label;
+            """;
 
         public const string Insert =
-            @"INSERT INTO
-                  Credentials (
-                      CredentialID,
-                      UserID,
-                      Description,
-                      Username,
-                      Password,
-                      Url,
-                      UserDefined1Label,
-                      UserDefined1,
-                      UserDefined2Label,
-                      UserDefined2,
-                      Notes,
-                      PwdOptions
-                  )
-              VALUES (
-                  @CredentialID,
-                  @UserID,
-                  @Description,
-                  @Username,
-                  @Password,
-                  @Url,
-                  @UserDefined1Label,
-                  @UserDefined1,
-                  @UserDefined2Label,
-                  @UserDefined2,
-                  @Notes,
-                  @PwdOptions
-              )";
+            """
+            INSERT INTO
+                Credentials (
+                    CredentialID,
+                    UserID,
+                    Description,
+                    Username,
+                    Password,
+                    Url,
+                    UserDefined1Label,
+                    UserDefined1,
+                    UserDefined2Label,
+                    UserDefined2,
+                    Notes,
+                    PwdOptions
+                )
+            VALUES (
+                @CredentialID,
+                @UserID,
+                @Description,
+                @Username,
+                @Password,
+                @Url,
+                @UserDefined1Label,
+                @UserDefined1,
+                @UserDefined2Label,
+                @UserDefined2,
+                @Notes,
+                @PwdOptions
+            );
+            """;
 
         public const string Update =
             @"UPDATE
@@ -77,5 +101,54 @@ public static class SqlStatements
 
         public const string Login =
             "SELECT UserID FROM Users WHERE Username = @Username AND Password = @Password";
+
+        public const string TagIndex =
+            """
+            SELECT
+                TagID,
+                Label
+            FROM
+                Tags
+            WHERE
+                UserID = @UserID
+            ORDER BY
+                Label;
+
+            SELECT
+                tc.TagID,
+                tc.CredentialID
+            FROM
+                Tags_Credentials tc
+            INNER JOIN
+                Tags t
+                    ON t.TagID = tc.TagID
+            WHERE
+                t.UserID = @UserID
+            ORDER BY
+                t.Label;
+            """;
+
+        public const string DeleteTagsFromCredential =
+            """
+            DELETE FROM
+                Tags_Credentials
+            WHERE
+                CredentialID = @CredentialID;
+            """;
+
+        public const string TagsToCredential =
+            """
+            INSERT INTO
+                Tags_Credentials (
+                    TagID,
+                    CredentialID
+                )
+            VALUES (
+                @TagID,
+                @CredentialID
+            );
+            """;
+
+        public static DatabaseType DatabaseType { get; internal set; }
     }
 }

Vault/Vault.csproj

@@ -21,16 +21,16 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="Dapper" Version="2.1.28" />
-        <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="8.0.2" />
-        <PackageReference Include="Microsoft.Data.SqlClient" Version="5.1.5" />
-        <PackageReference Include="Microsoft.TypeScript.MSBuild" Version="5.3.3">
+        <PackageReference Include="Dapper" Version="2.1.35" />
+        <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="8.0.6" />
+        <PackageReference Include="Microsoft.Data.SqlClient" Version="5.2.1" />
+        <PackageReference Include="Microsoft.TypeScript.MSBuild" Version="5.4.5">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
         <PackageReference Include="Microsoft.VisualStudio.Validation" Version="17.8.8" />
         <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-        <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
+        <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
         </PackageReference>

Vault/Views/Home/GenerateVaultCredential.cshtml

@@ -59,7 +59,7 @@
 
 @section foot {
 
-    <script src="~/js/dist/GenerateVaultCredential.min.js" asp-append-version="true" integrity="sha512-9OWfKRWszrMsJVs9BfTvW0UVWrtwFoMza9yBfydxO2nKWBc8egYdmqIb1R+qk5c/fhKqb8RU69Ix4V24vSrZwg=="></script>
+    <script src="~/js/dist/GenerateVaultCredential.min.js" asp-append-version="true" integrity="sha512-23UXvk9rGJ+cQqYRdNSJ1OGFQg0i2IlfETQAiPiRJY8STjomBunAKlPzh82vMdxAsVHhuyFKBTYRXROxZd8kDg=="></script>
 
     <div class="modal-backdrop show"></div>
 

Vault/Views/Home/Index.cshtml

@@ -20,6 +20,6 @@
         var _VAULT_GLOBALS = @Html.Raw(Model.AsJson());
     </script>
 
-    <script src="~/js/dist/Index.min.js" asp-append-version="true" integrity="sha512-UEtyhazndztA2yrv+IH6Z/dqZelvww/TTBVcCmgIO1EUzJey4fh7b1gskCFJDepKUp7cY4iCCFvqi1JxXI345A=="></script>
+    <script src="~/js/dist/Index.min.js" asp-append-version="true" integrity="sha512-JRoo5LPc8JUVUptWJbAqIZpbVwt7xeoW9Sy687sV+XFzIveba9Tcli48CvpWjD+qjzQFw9+OdboKeo9AU18MAg=="></script>
 
 }