Basic envers verification

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/resolvers/FileBackedHttpMetadataResolver.java

@@ -1,9 +1,12 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain.resolvers;
 
+import edu.internet2.tier.shibboleth.admin.ui.domain.AbstractAuditable;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Setter;
 import lombok.ToString;
+import org.hibernate.envers.AuditOverride;
+import org.hibernate.envers.Audited;
 
 import javax.persistence.Embedded;
 import javax.persistence.Entity;
@@ -13,6 +16,8 @@
 @Getter
 @Setter
 @ToString
+@Audited
+@AuditOverride(forClass = AbstractAuditable.class)
 public class FileBackedHttpMetadataResolver extends MetadataResolver {
     public FileBackedHttpMetadataResolver() {
         type = "FileBackedHttpMetadataResolver";

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/resolvers/MetadataResolver.java

@@ -11,7 +11,6 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.ToString;
-import org.hibernate.envers.AuditOverride;
 import org.hibernate.envers.Audited;
 
 import javax.persistence.CascadeType;
@@ -40,7 +39,6 @@
         @JsonSubTypes.Type(value = FilesystemMetadataResolver.class, name = "FilesystemMetadataResolver"),
         @JsonSubTypes.Type(value = ResourceBackedMetadataResolver.class, name = "ResourceBackedMetadataResolver")})
 @Audited
-@AuditOverride(forClass = AbstractAuditable.class)
 public class MetadataResolver extends AbstractAuditable {
 
     @JsonProperty("@type")

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/envers/PrincipalAwareRevisionEntity.java

@@ -0,0 +1,20 @@
+package edu.internet2.tier.shibboleth.admin.ui.envers;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.hibernate.envers.DefaultRevisionEntity;
+import org.hibernate.envers.RevisionEntity;
+
+import javax.persistence.Entity;
+
+/**
+ * Extension of the default envers revision entity to track authenticated principals
+ */
+@Entity
+@RevisionEntity(PrincipalEnhancingRevisionListener.class)
+@Getter
+@Setter
+public class PrincipalAwareRevisionEntity extends DefaultRevisionEntity {
+
+    private String principalUserName;
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/envers/PrincipalEnhancingRevisionListener.java

@@ -0,0 +1,20 @@
+package edu.internet2.tier.shibboleth.admin.ui.envers;
+
+import org.hibernate.envers.RevisionListener;
+
+import static edu.internet2.tier.shibboleth.admin.ui.security.springsecurity.PrincipalAccessor.currentPrincipalIfLoggedIn;
+
+/**
+ * Implementation of envers revision listener to enhance revision entity with authenticated principal username.
+ */
+public class PrincipalEnhancingRevisionListener implements RevisionListener {
+
+    private static final String ANONYMOUS = "anonymous";
+
+    @Override
+    public void newRevision(Object revisionEntity) {
+        PrincipalAwareRevisionEntity rev = (PrincipalAwareRevisionEntity) revisionEntity;
+        String user = currentPrincipalIfLoggedIn().orElse(ANONYMOUS);
+        rev.setPrincipalUserName(user);
+    }
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/security/springsecurity/PrincipalAccessor.java

@@ -0,0 +1,21 @@
+package edu.internet2.tier.shibboleth.admin.ui.security.springsecurity;
+
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
+
+import java.util.Optional;
+
+public final class PrincipalAccessor {
+
+    //Non-instantiable utility class
+    private PrincipalAccessor() {
+    }
+
+    public static Optional<String> currentPrincipalIfLoggedIn() {
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        if (authentication == null) {
+            return Optional.empty();
+        }
+        return Optional.of(authentication.getName());
+    }
+}

backend/src/test/groovy/edu/internet2/tier/shibboleth/admin/ui/repository/envers/MetadataResolverEntityBasicEnversVersioningTests.groovy

@@ -49,7 +49,13 @@ class MetadataResolverEntityBasicEnversVersioningTests extends Specification {
         def metadataResolverHistory = resolverHistory()
 
         then:
-        metadataResolverHistory
+        metadataResolverHistory.size() == 1
+
+        when:
+        def rev = metadataResolverHistory[0]
+
+        then:
+        rev[1].principalUserName == 'anonymous'
 
         when:
         mdr.name = 'Updated'
@@ -59,7 +65,7 @@ class MetadataResolverEntityBasicEnversVersioningTests extends Specification {
         metadataResolverHistory = resolverHistory()
 
         then:
-        metadataResolverHistory
+        metadataResolverHistory.size == 2
     }
 
     private resolverHistory() {