feat[backend](log_events): added logs on every system admin operation

Author: AlexSanchez-bit

backend/src/main/java/com/park/utmstack/domain/UtmServerModule.java

@@ -1,15 +1,18 @@
 package com.park.utmstack.domain;
 
 
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
+
 import javax.persistence.*;
 import java.io.Serializable;
+import java.util.Map;
 
 /**
  * A UtmServerModule.
  */
 @Entity
 @Table(name = "utm_server_module")
-public class UtmServerModule implements Serializable {
+public class UtmServerModule implements Serializable, AuditableDTO {
 
     private static final long serialVersionUID = 1L;
 
@@ -100,4 +103,12 @@ public UtmServer getServer() {
     public void setServer(UtmServer server) {
         this.server = server;
     }
+
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of(
+            "moduleName", moduleName != null ? moduleName : "",
+            "prettyName", prettyName != null ? prettyName : ""
+        );
+    }
 }

backend/src/main/java/com/park/utmstack/domain/application_events/enums/ApplicationEventType.java

@@ -50,5 +50,53 @@ public enum ApplicationEventType {
     COLLECTOR_DELETE_SUCCESS,
     RESET_USER_PASSWORD_ATTEMPT,
     RESET_USER_PASSWORD_SUCCESS,
+    USER_CREATION_ATTEMPT,
+    USER_CREATION_SUCCESS,
+    USER_UPDATE_ATTEMPT,
+    USER_UPDATE_SUCCESS,
+    USER_DELETE_ATTEMPT,
+    USER_DELETE_SUCCESS,
+    PASSWORD_CHANGE_ATTEMPT,
+    PASSWORD_CHANGE_SUCCESS,
+    IDP_CONFIG_CREATE_ATTEMPT,
+    IDP_CONFIG_CREATE_SUCCESS,
+    IDP_CONFIG_UPDATE_ATTEMPT,
+    IDP_CONFIG_UPDATE_SUCCESS,
+    IDP_CONFIG_DELETE_ATTEMPT,
+    IDP_CONFIG_DELETE_SUCCESS,
+    TFA_ENABLE_ATTEMPT,
+    TFA_ENABLE_SUCCESS,
+    TFA_DISABLE_ATTEMPT,
+    TFA_DISABLE_SUCCESS,
+    API_KEY_CREATE_ATTEMPT,
+    API_KEY_CREATE_SUCCESS,
+    API_KEY_DELETE_ATTEMPT,
+    API_KEY_DELETE_SUCCESS,
+    CORRELATION_RULE_CREATE_ATTEMPT,
+    CORRELATION_RULE_CREATE_SUCCESS,
+    CORRELATION_RULE_UPDATE_ATTEMPT,
+    CORRELATION_RULE_UPDATE_SUCCESS,
+    CORRELATION_RULE_DELETE_ATTEMPT,
+    CORRELATION_RULE_DELETE_SUCCESS,
+    LOGSTASH_FILTER_CREATE_ATTEMPT,
+    LOGSTASH_FILTER_CREATE_SUCCESS,
+    LOGSTASH_FILTER_UPDATE_ATTEMPT,
+    LOGSTASH_FILTER_UPDATE_SUCCESS,
+    LOGSTASH_FILTER_DELETE_ATTEMPT,
+    LOGSTASH_FILTER_DELETE_SUCCESS,
+    SERVER_MODULE_CREATE_ATTEMPT,
+    SERVER_MODULE_CREATE_SUCCESS,
+    SERVER_MODULE_UPDATE_ATTEMPT,
+    SERVER_MODULE_UPDATE_SUCCESS,
+    SERVER_MODULE_DELETE_ATTEMPT,
+    SERVER_MODULE_DELETE_SUCCESS,
+    COMPLIANCE_SCHEDULE_CREATE_ATTEMPT,
+    COMPLIANCE_SCHEDULE_CREATE_SUCCESS,
+    COMPLIANCE_SCHEDULE_DELETE_ATTEMPT,
+    COMPLIANCE_SCHEDULE_DELETE_SUCCESS,
+    COMPLIANCE_STANDARD_CREATE_ATTEMPT,
+    COMPLIANCE_STANDARD_CREATE_SUCCESS,
+    REPORT_IMPORT_ATTEMPT,
+    REPORT_IMPORT_SUCCESS,
     UNDEFINED
 }

backend/src/main/java/com/park/utmstack/domain/compliance/UtmComplianceReportConfig.java

@@ -11,6 +11,7 @@
 import com.park.utmstack.domain.compliance.enums.ComplianceType;
 import com.park.utmstack.domain.compliance.types.RequestParamFilter;
 import com.park.utmstack.domain.shared_types.DataColumn;
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
 import com.park.utmstack.util.UtilSerializer;
 import com.park.utmstack.util.exceptions.UtmSerializationException;
 import org.hibernate.annotations.GenericGenerator;
@@ -20,13 +21,14 @@
 import javax.persistence.*;
 import java.io.Serializable;
 import java.util.List;
+import java.util.Map;
 
 /**
  * A ComplianceTemplate.
  */
 @Entity
 @Table(name = "utm_compliance_report_config")
-public class UtmComplianceReportConfig implements Serializable {
+public class UtmComplianceReportConfig implements Serializable, AuditableDTO {
 
     private static final long serialVersionUID = 1L;
 
@@ -351,4 +353,12 @@ public ComplianceStatus getConfigReportStatus() {
     public void setConfigReportStatus(ComplianceStatus complianceStatus) {
         this.configReportStatus = complianceStatus;
     }
+
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of(
+            "configReportName", configReportName != null ? configReportName : "",
+            "configSolution", configSolution != null ? configSolution : ""
+        );
+    }
 }

backend/src/main/java/com/park/utmstack/domain/compliance/UtmComplianceReportSchedule.java

@@ -7,9 +7,12 @@
 import com.park.utmstack.util.UtilSerializer;
 import com.park.utmstack.util.exceptions.UtmSerializationException;
 
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
+
 import java.io.Serializable;
 import java.time.Instant;
 import java.util.List;
+import java.util.Map;
 import javax.persistence.*;
 import javax.validation.constraints.Size;
 
@@ -18,7 +21,7 @@
  */
 @Entity
 @Table(name = "utm_compliance_report_schedule")
-public class UtmComplianceReportSchedule implements Serializable {
+public class UtmComplianceReportSchedule implements Serializable, AuditableDTO {
 
     private static final long serialVersionUID = 1L;
 
@@ -124,6 +127,14 @@ public void setUrlWithParams(String urlWithParams) {
         this.urlWithParams = urlWithParams;
     }
 
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of(
+            "complianceId", complianceId != null ? complianceId : "",
+            "scheduleString", scheduleString != null ? scheduleString : ""
+        );
+    }
+
     @Override
     public boolean equals(Object o) {
         if (o instanceof UtmComplianceReportSchedule) {

backend/src/main/java/com/park/utmstack/domain/compliance/UtmComplianceStandard.java

@@ -1,17 +1,19 @@
 package com.park.utmstack.domain.compliance;
 
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
 import lombok.Getter;
 import lombok.Setter;
 import org.hibernate.annotations.GenericGenerator;
 
 import javax.persistence.*;
 import java.io.Serializable;
+import java.util.Map;
 
 @Setter
 @Getter
 @Entity
 @Table(name = "utm_compliance_standard")
-public class UtmComplianceStandard implements Serializable {
+public class UtmComplianceStandard implements Serializable, AuditableDTO {
     private static final long serialVersionUID = 1L;
 
     @Id
@@ -28,4 +30,11 @@ public class UtmComplianceStandard implements Serializable {
     @Column(name = "system_owner")
     private Boolean systemOwner;
 
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of(
+            "standardName", standardName != null ? standardName : ""
+        );
+    }
+
 }

backend/src/main/java/com/park/utmstack/domain/logstash_filter/UtmLogstashFilter.java

@@ -4,20 +4,22 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.park.utmstack.domain.application_modules.UtmModule;
 import com.park.utmstack.domain.correlation.config.UtmDataTypes;
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
 import org.hibernate.annotations.GenericGenerator;
 
 import javax.persistence.*;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotNull;
 import java.io.Serializable;
 import java.time.Instant;
+import java.util.Map;
 
 /**
  * A UtmLogstashFilter.
  */
 @Entity
 @Table(name = "utm_logstash_filter")
-public class UtmLogstashFilter implements Serializable {
+public class UtmLogstashFilter implements Serializable, AuditableDTO {
 
     private static final long serialVersionUID = 1L;
 
@@ -182,4 +184,12 @@ public Instant getUpdatedAt() {
     public void setUpdatedAt(Instant updatedAt) {
         this.updatedAt = updatedAt;
     }
+
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of(
+            "filterName", filterName != null ? filterName : "",
+            "moduleName", moduleName != null ? moduleName : ""
+        );
+    }
 }

backend/src/main/java/com/park/utmstack/service/dto/PasswordChangeDTO.java

@@ -1,9 +1,12 @@
 package com.park.utmstack.service.dto;
 
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
+import java.util.Map;
+
 /**
  * A DTO representing a password change required data - current and new password.
  */
-public class PasswordChangeDTO {
+public class PasswordChangeDTO implements AuditableDTO {
     private String currentPassword;
     private String newPassword;
 
@@ -16,6 +19,11 @@ public PasswordChangeDTO(String currentPassword, String newPassword) {
         this.newPassword = newPassword;
     }
 
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of("action", "password_change");
+    }
+
     public String getCurrentPassword() {
 
         return currentPassword;

backend/src/main/java/com/park/utmstack/service/dto/UserDTO.java

@@ -4,18 +4,21 @@
 import com.park.utmstack.domain.Authority;
 import com.park.utmstack.domain.User;
 
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
+
 import javax.validation.constraints.Email;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Pattern;
 import javax.validation.constraints.Size;
 import java.time.Instant;
+import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
 
 /**
  * A DTO representing a user, with his authorities.
  */
-public class UserDTO {
+public class UserDTO implements AuditableDTO {
 
     private Long id;
 
@@ -187,6 +190,15 @@ public void setTfaSecret(String tfaSecret) {
         this.tfaSecret = tfaSecret;
     }
 
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of(
+            "login", login != null ? login : "",
+            "email", email != null ? email : "",
+            "authorities", authorities != null ? authorities.toString() : ""
+        );
+    }
+
     @Override
     public String toString() {
         return "UserDTO{" + "login='" + login + '\'' + ", firstName='" + firstName + '\'' + ", lastName='" + lastName + '\'' + ", email='" + email + '\'' + ", imageUrl='" + imageUrl + '\'' + ", activated=" + activated + ", langKey='" + langKey + '\'' + ", createdBy=" + createdBy + ", createdDate=" + createdDate + ", lastModifiedBy='" + lastModifiedBy + '\'' + ", lastModifiedDate=" + lastModifiedDate + ", authorities=" + authorities + "}";

backend/src/main/java/com/park/utmstack/service/dto/correlation/UtmCorrelationRulesDTO.java

@@ -4,6 +4,7 @@
 import com.park.utmstack.domain.correlation.rules.AfterEvents;
 import com.park.utmstack.domain.correlation.rules.RuleDefinition;
 import com.park.utmstack.domain.correlation.rules.SearchRequest;
+import com.park.utmstack.service.dto.auditable.AuditableDTO;
 import lombok.Data;
 import lombok.Getter;
 import lombok.Setter;
@@ -12,10 +13,11 @@
 import javax.validation.constraints.*;
 import java.io.Serializable;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 @Data
-public class UtmCorrelationRulesDTO implements Serializable {
+public class UtmCorrelationRulesDTO implements Serializable, AuditableDTO {
 
     private static final long serialVersionUID = 1L;
 
@@ -64,5 +66,14 @@ public class UtmCorrelationRulesDTO implements Serializable {
 
     private List<String> groupBy;
 
+    @Override
+    public Map<String, Object> toAuditMap() {
+        return Map.of(
+            "name", name != null ? name : "",
+            "category", category != null ? category : "",
+            "technique", technique != null ? technique : ""
+        );
+    }
+
 }