[backend] feat(multi-tenancy): add default tenant migration and foreign keys (#3505)

openaev-api/src/main/java/io/openaev/migration/V4_74__Create_default_tenant.java

@@ -0,0 +1,95 @@
+package io.openaev.migration;
+
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
+
+import java.sql.Statement;
+import java.util.List;
+import org.flywaydb.core.api.migration.BaseJavaMigration;
+import org.flywaydb.core.api.migration.Context;
+import org.springframework.stereotype.Component;
+
+@Component
+public class V4_74__Create_default_tenant extends BaseJavaMigration {
+
+  // Strings to replace in the SQL statement
+  private static List<String> TABLES =
+      List.of(
+          "agents",
+          "asset_agent_jobs",
+          "asset_groups",
+          "assets",
+          "attack_patterns",
+          "challenges",
+          "channels",
+          "collectors",
+          "connector_instances",
+          "custom_dashboards",
+          "datapacks",
+          "documents",
+          "executors",
+          "exercises",
+          "findings",
+          "groups",
+          "import_mappers",
+          "injectors",
+          "injects",
+          "kill_chain_phases",
+          "lessons_templates",
+          "mitigations",
+          "organizations",
+          "notification_rules",
+          "payloads",
+          "roles",
+          "scenarios",
+          "tag_rules",
+          "tags",
+          "teams",
+          "vulnerabilities");
+
+  @Override
+  public void migrate(Context context) throws Exception {
+    try (Statement statement = context.getConnection().createStatement()) {
+      // Add default tenant
+      statement.execute(
+          String.format(
+              """
+                INSERT INTO tenants(tenant_id, tenant_name, tenant_description)
+                VALUES ('%s', 'First default tenant auto created to rename', 'First default tenant auto created to rename');
+                """,
+              DEFAULT_TENANT_UUID));
+      // Add deleted_at in tenants for soft delete
+      statement.execute("ALTER TABLE tenants ADD tenant_deleted_at TIMESTAMP WITH TIME ZONE;");
+      // Add foreign keys with index, auto set default tenant id with default value
+      for (String table : TABLES) {
+        statement.addBatch(
+            String.format(
+                """
+                  ALTER TABLE %s
+                     ADD COLUMN tenant_id VARCHAR(255) NOT NULL DEFAULT '%s',
+                     ADD CONSTRAINT fk_tenant_id FOREIGN KEY (tenant_id) REFERENCES tenants(tenant_id) ON DELETE CASCADE;
+                  """,
+                table, DEFAULT_TENANT_UUID));
+        statement.addBatch(
+            String.format(
+                """
+                  CREATE INDEX IF NOT EXISTS idx_tenant_id ON %s(tenant_id);
+                  """,
+                table));
+      }
+      statement.executeBatch();
+      // Add linked table for users and tenants
+      statement.execute(
+          """
+                    CREATE TABLE IF NOT EXISTS users_tenants (
+                        user_id VARCHAR(255) NOT NULL,
+                        tenant_id VARCHAR(255) NOT NULL,
+                        PRIMARY KEY (user_id, tenant_id),
+                        CONSTRAINT fk_user_id FOREIGN KEY (user_id) REFERENCES users(user_id) ON DELETE CASCADE,
+                        CONSTRAINT fk_tenant_id FOREIGN KEY (tenant_id) REFERENCES tenants(tenant_id) ON DELETE CASCADE
+                    );
+                """);
+      statement.execute("CREATE INDEX IF NOT EXISTS idx_user_id ON users_tenants(user_id);");
+      statement.execute("CREATE INDEX IF NOT EXISTS idx_tenant_id ON users_tenants(tenant_id);");
+    }
+  }
+}

openaev-model/src/main/java/io/openaev/context/TenantContext.java

@@ -0,0 +1,18 @@
+package io.openaev.context;
+
+import io.openaev.database.model.Tenant;
+
+public class TenantContext {
+
+  private static final ThreadLocal<String> CURRENT_TENANT = new ThreadLocal<>();
+
+  public static String getCurrentTenant() {
+    return Tenant.DEFAULT_TENANT_UUID;
+    // return CURRENT_TENANT.get();
+  }
+
+  // TODO multi-tenancy: set with Front URL instead of default UUID and update the return above
+  public static void setCurrentTenant(String tenant) {
+    CURRENT_TENANT.set(tenant);
+  }
+}

openaev-model/src/main/java/io/openaev/database/model/Agent.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static java.time.Instant.now;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -144,6 +145,13 @@ public boolean isActive() {
   @Transient
   private final ResourceType resourceType = ResourceType.AGENT;
 
+  // Ignore json and not null
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @Override
   public int hashCode() {
     return Objects.hash(id);

openaev-model/src/main/java/io/openaev/database/model/Asset.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static jakarta.persistence.DiscriminatorType.STRING;
 import static java.time.Instant.now;
 import static lombok.AccessLevel.NONE;
@@ -63,6 +64,12 @@ public class Asset implements Base {
   @JsonProperty("asset_external_reference")
   private String externalReference;
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   // -- TAG --
 
   @Schema(implementation = String[].class)

openaev-model/src/main/java/io/openaev/database/model/AssetAgentJob.java

@@ -1,12 +1,16 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import io.openaev.database.audit.ModelBaseListener;
 import io.openaev.helper.MonoIdSerializer;
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.persistence.*;
 import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
 import java.util.Objects;
 import lombok.Data;
 import lombok.Getter;
@@ -48,6 +52,12 @@ public class AssetAgentJob implements Base {
   @NotBlank
   private String command;
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @Override
   public String toString() {
     return id;

openaev-model/src/main/java/io/openaev/database/model/AssetGroup.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static java.time.Instant.now;
 import static lombok.AccessLevel.NONE;
 
@@ -57,6 +58,12 @@ public class AssetGroup implements Base {
   @JsonProperty("asset_group_external_reference")
   private String externalReference;
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   // -- ASSET --
 
   @Type(JsonType.class)

openaev-model/src/main/java/io/openaev/database/model/AttackPattern.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static java.time.Instant.now;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -14,6 +15,7 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.persistence.*;
 import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
 import java.time.Instant;
 import java.util.ArrayList;
 import java.util.List;
@@ -101,6 +103,12 @@ public class AttackPattern implements Base {
   @JsonProperty("attack_pattern_kill_chain_phases")
   private List<KillChainPhase> killChainPhases = new ArrayList<>();
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @Getter(onMethod_ = @JsonIgnore)
   @Transient
   private final ResourceType resourceType = ResourceType.ATTACK_PATTERN;

openaev-model/src/main/java/io/openaev/database/model/Challenge.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static java.time.Instant.now;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -97,6 +98,12 @@ public class Challenge implements Base {
   @JsonProperty("challenge_documents")
   private List<Document> documents = new ArrayList<>();
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @Transient private List<String> exerciseIds = new ArrayList<>();
 
   @Transient private List<String> scenarioIds = new ArrayList<>();

openaev-model/src/main/java/io/openaev/database/model/Channel.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static java.time.Instant.now;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -90,6 +91,12 @@ public class Channel implements Base {
   @Schema(implementation = String.class)
   private Document logoLight;
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @Getter(onMethod_ = @JsonIgnore)
   @Transient
   private final ResourceType resourceType = ResourceType.CHANNEL;

openaev-model/src/main/java/io/openaev/database/model/Collector.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static java.time.Instant.now;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -71,6 +72,12 @@ public class Collector extends BaseConnectorEntity {
   @Type(JsonType.class)
   private ObjectNode state;
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @Getter(onMethod_ = @JsonIgnore)
   @Transient
   private final ResourceType resourceType = ResourceType.COLLECTOR;

openaev-model/src/main/java/io/openaev/database/model/ConnectorInstancePersisted.java

@@ -1,6 +1,9 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
+
 import com.fasterxml.jackson.annotation.JsonBackReference;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.openaev.database.audit.ModelBaseListener;
 import jakarta.persistence.*;
@@ -90,6 +93,12 @@ public class ConnectorInstancePersisted extends ConnectorInstance implements Bas
   @NotNull
   private Set<ConnectorInstanceConfiguration> configurations = new HashSet<>();
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @Override
   public String getClassName() {
     if (this.getCatalogConnector() != null) {

openaev-model/src/main/java/io/openaev/database/model/CustomDashboard.java

@@ -1,5 +1,6 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
 import static jakarta.persistence.FetchType.LAZY;
 import static java.time.Instant.now;
 import static java.util.function.Function.identity;
@@ -68,6 +69,12 @@ public class CustomDashboard implements Base {
   @OrderBy("id ASC")
   private List<CustomDashboardParameters> parameters = new ArrayList<>();
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   public CustomDashboard addParameter(
       @NotBlank final String name, @NotBlank final CustomDashboardParameterType type) {
     if (this.getParameters().stream().anyMatch(p -> p.getType().equals(type) && type.uniq)) {

openaev-model/src/main/java/io/openaev/database/model/DataPack.java

@@ -1,8 +1,12 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import jakarta.persistence.*;
 import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -16,4 +20,10 @@ public class DataPack {
   @JsonProperty("datapack_id")
   @NotBlank
   private String id;
+
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
 }

openaev-model/src/main/java/io/openaev/database/model/Document.java

@@ -1,5 +1,7 @@
 package io.openaev.database.model;
 
+import static io.openaev.database.model.Tenant.DEFAULT_TENANT_UUID;
+
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
@@ -9,6 +11,7 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.persistence.*;
 import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
 import java.util.HashSet;
 import java.util.Objects;
 import java.util.Set;
@@ -108,6 +111,12 @@ public class Document implements Base {
   @JsonIgnore
   private Set<Challenge> challenges = new HashSet<>();
 
+  @ManyToOne
+  @JoinColumn(name = "tenant_id")
+  @JsonIgnore
+  @NotNull
+  private Tenant tenant = new Tenant(DEFAULT_TENANT_UUID);
+
   @OneToMany(mappedBy = "document", fetch = FetchType.LAZY)
   @JsonIgnore
   private Set<InjectDocument> injectDocuments = new HashSet<>();