Package com.floragunn.searchguard.auditlog.impl

Class AbstractAuditLog

  • All Implemented Interfaces:
    com.floragunn.searchguard.auditlog.AuditLog, Closeable, AutoCloseable
    Direct Known Subclasses:
    AuditLogImpl
    public abstract class AbstractAuditLog
extends Object
implements com.floragunn.searchguard.auditlog.AuditLog

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface com.floragunn.searchguard.auditlog.AuditLog

        com.floragunn.searchguard.auditlog.AuditLog.Operation, com.floragunn.searchguard.auditlog.AuditLog.Origin

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractAuditLog​(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.threadpool.ThreadPool threadPool, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver resolver, org.elasticsearch.cluster.service.ClusterService clusterService)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void logBadHeaders​(org.elasticsearch.rest.RestRequest request)  
      void logBadHeaders​(org.elasticsearch.transport.TransportRequest request, String action, org.elasticsearch.tasks.Task task)  
      void logBlockedIp​(org.elasticsearch.rest.RestRequest request, InetSocketAddress remoteAddress)  
      void logBlockedIp​(org.elasticsearch.transport.TransportRequest request, String action, org.elasticsearch.common.transport.TransportAddress remoteAddress, org.elasticsearch.tasks.Task task)  
      void logBlockedUser​(String effectiveUser, boolean sgadmin, String initiatingUser, org.elasticsearch.rest.RestRequest request)  
      void logBlockedUser​(String effectiveUser, boolean sgadmin, String initiatingUser, org.elasticsearch.transport.TransportRequest request, org.elasticsearch.tasks.Task task)  
      void logDocumentDeleted​(org.elasticsearch.index.shard.ShardId shardId, org.elasticsearch.index.engine.Engine.Delete delete, org.elasticsearch.index.engine.Engine.DeleteResult result)  
      void logDocumentRead​(String index, String id, org.elasticsearch.index.shard.ShardId shardId, Map<String,​String> fieldNameValues, com.floragunn.searchguard.compliance.ComplianceConfig complianceConfig)  
      void logDocumentWritten​(org.elasticsearch.index.shard.ShardId shardId, org.elasticsearch.index.get.GetResult originalResult, org.elasticsearch.index.engine.Engine.Index currentIndex, org.elasticsearch.index.engine.Engine.IndexResult result, com.floragunn.searchguard.compliance.ComplianceConfig complianceConfig)  
      void logExternalConfig​(org.elasticsearch.common.settings.Settings settings, org.elasticsearch.env.Environment environment)  
      void logFailedLogin​(String effectiveUser, boolean sgadmin, String initiatingUser, org.elasticsearch.rest.RestRequest request)  
      void logFailedLogin​(String effectiveUser, boolean sgadmin, String initiatingUser, org.elasticsearch.transport.TransportRequest request, org.elasticsearch.tasks.Task task)  
      void logGrantedPrivileges​(String privilege, org.elasticsearch.transport.TransportRequest request, org.elasticsearch.tasks.Task task)  
      void logImmutableIndexAttempt​(org.elasticsearch.transport.TransportRequest request, String action, org.elasticsearch.tasks.Task task)  
      void logMissingPrivileges​(String privilege, String effectiveUser, org.elasticsearch.rest.RestRequest request)  
      void logMissingPrivileges​(String privilege, org.elasticsearch.transport.TransportRequest request, org.elasticsearch.tasks.Task task)  
      void logSgIndexAttempt​(org.elasticsearch.transport.TransportRequest request, String action, org.elasticsearch.tasks.Task task)  
      void logSSLException​(org.elasticsearch.rest.RestRequest request, Throwable t)  
      void logSSLException​(org.elasticsearch.transport.TransportRequest request, Throwable t, String action, org.elasticsearch.tasks.Task task)  
      void logSucceededLogin​(String effectiveUser, boolean sgadmin, String initiatingUser, org.elasticsearch.rest.RestRequest request)  
      void logSucceededLogin​(String effectiveUser, boolean sgadmin, String initiatingUser, org.elasticsearch.transport.TransportRequest request, String action, org.elasticsearch.tasks.Task task)  
      protected abstract void save​(AuditMessage msg)  

      • Methods inherited from interface com.floragunn.searchguard.auditlog.AuditLog

        setComplianceConfig

    • Field Detail

      • log

        protected final org.apache.logging.log4j.Logger log

      • threadPool

        protected final org.elasticsearch.threadpool.ThreadPool threadPool

      • resolver

        protected final org.elasticsearch.cluster.metadata.IndexNameExpressionResolver resolver

      • clusterService

        protected final org.elasticsearch.cluster.service.ClusterService clusterService

      • settings

        protected final org.elasticsearch.common.settings.Settings settings

      • restAuditingEnabled

        protected final boolean restAuditingEnabled

      • transportAuditingEnabled

        protected final boolean transportAuditingEnabled

      • resolveBulkRequests

        protected final boolean resolveBulkRequests

      • logRequestBody

        protected final boolean logRequestBody

      • resolveIndices

        protected final boolean resolveIndices

    • Constructor Detail

      • AbstractAuditLog

        protected AbstractAuditLog​(org.elasticsearch.common.settings.Settings settings,
                           org.elasticsearch.threadpool.ThreadPool threadPool,
                           org.elasticsearch.cluster.metadata.IndexNameExpressionResolver resolver,
                           org.elasticsearch.cluster.service.ClusterService clusterService)

    • Method Detail

      • logFailedLogin

        public void logFailedLogin​(String effectiveUser,
                           boolean sgadmin,
                           String initiatingUser,
                           org.elasticsearch.transport.TransportRequest request,
                           org.elasticsearch.tasks.Task task)
        Specified by:
        logFailedLogin in interface com.floragunn.searchguard.auditlog.AuditLog

      • logFailedLogin

        public void logFailedLogin​(String effectiveUser,
                           boolean sgadmin,
                           String initiatingUser,
                           org.elasticsearch.rest.RestRequest request)
        Specified by:
        logFailedLogin in interface com.floragunn.searchguard.auditlog.AuditLog

      • logBlockedUser

        public void logBlockedUser​(String effectiveUser,
                           boolean sgadmin,
                           String initiatingUser,
                           org.elasticsearch.transport.TransportRequest request,
                           org.elasticsearch.tasks.Task task)
        Specified by:
        logBlockedUser in interface com.floragunn.searchguard.auditlog.AuditLog

      • logBlockedUser

        public void logBlockedUser​(String effectiveUser,
                           boolean sgadmin,
                           String initiatingUser,
                           org.elasticsearch.rest.RestRequest request)
        Specified by:
        logBlockedUser in interface com.floragunn.searchguard.auditlog.AuditLog

      • logSucceededLogin

        public void logSucceededLogin​(String effectiveUser,
                              boolean sgadmin,
                              String initiatingUser,
                              org.elasticsearch.transport.TransportRequest request,
                              String action,
                              org.elasticsearch.tasks.Task task)
        Specified by:
        logSucceededLogin in interface com.floragunn.searchguard.auditlog.AuditLog

      • logSucceededLogin

        public void logSucceededLogin​(String effectiveUser,
                              boolean sgadmin,
                              String initiatingUser,
                              org.elasticsearch.rest.RestRequest request)
        Specified by:
        logSucceededLogin in interface com.floragunn.searchguard.auditlog.AuditLog

      • logMissingPrivileges

        public void logMissingPrivileges​(String privilege,
                                 String effectiveUser,
                                 org.elasticsearch.rest.RestRequest request)
        Specified by:
        logMissingPrivileges in interface com.floragunn.searchguard.auditlog.AuditLog

      • logMissingPrivileges

        public void logMissingPrivileges​(String privilege,
                                 org.elasticsearch.transport.TransportRequest request,
                                 org.elasticsearch.tasks.Task task)
        Specified by:
        logMissingPrivileges in interface com.floragunn.searchguard.auditlog.AuditLog

      • logGrantedPrivileges

        public void logGrantedPrivileges​(String privilege,
                                 org.elasticsearch.transport.TransportRequest request,
                                 org.elasticsearch.tasks.Task task)
        Specified by:
        logGrantedPrivileges in interface com.floragunn.searchguard.auditlog.AuditLog

      • logBadHeaders

        public void logBadHeaders​(org.elasticsearch.transport.TransportRequest request,
                          String action,
                          org.elasticsearch.tasks.Task task)
        Specified by:
        logBadHeaders in interface com.floragunn.searchguard.auditlog.AuditLog

      • logBadHeaders

        public void logBadHeaders​(org.elasticsearch.rest.RestRequest request)
        Specified by:
        logBadHeaders in interface com.floragunn.searchguard.auditlog.AuditLog

      • logBlockedIp

        public void logBlockedIp​(org.elasticsearch.transport.TransportRequest request,
                         String action,
                         org.elasticsearch.common.transport.TransportAddress remoteAddress,
                         org.elasticsearch.tasks.Task task)
        Specified by:
        logBlockedIp in interface com.floragunn.searchguard.auditlog.AuditLog

      • logBlockedIp

        public void logBlockedIp​(org.elasticsearch.rest.RestRequest request,
                         InetSocketAddress remoteAddress)
        Specified by:
        logBlockedIp in interface com.floragunn.searchguard.auditlog.AuditLog

      • logSgIndexAttempt

        public void logSgIndexAttempt​(org.elasticsearch.transport.TransportRequest request,
                              String action,
                              org.elasticsearch.tasks.Task task)
        Specified by:
        logSgIndexAttempt in interface com.floragunn.searchguard.auditlog.AuditLog

      • logImmutableIndexAttempt

        public void logImmutableIndexAttempt​(org.elasticsearch.transport.TransportRequest request,
                                     String action,
                                     org.elasticsearch.tasks.Task task)
        Specified by:
        logImmutableIndexAttempt in interface com.floragunn.searchguard.auditlog.AuditLog

      • logSSLException

        public void logSSLException​(org.elasticsearch.transport.TransportRequest request,
                            Throwable t,
                            String action,
                            org.elasticsearch.tasks.Task task)
        Specified by:
        logSSLException in interface com.floragunn.searchguard.auditlog.AuditLog

      • logSSLException

        public void logSSLException​(org.elasticsearch.rest.RestRequest request,
                            Throwable t)
        Specified by:
        logSSLException in interface com.floragunn.searchguard.auditlog.AuditLog

      • logDocumentRead

        public void logDocumentRead​(String index,
                            String id,
                            org.elasticsearch.index.shard.ShardId shardId,
                            Map<String,​String> fieldNameValues,
                            com.floragunn.searchguard.compliance.ComplianceConfig complianceConfig)
        Specified by:
        logDocumentRead in interface com.floragunn.searchguard.auditlog.AuditLog

      • logDocumentWritten

        public void logDocumentWritten​(org.elasticsearch.index.shard.ShardId shardId,
                               org.elasticsearch.index.get.GetResult originalResult,
                               org.elasticsearch.index.engine.Engine.Index currentIndex,
                               org.elasticsearch.index.engine.Engine.IndexResult result,
                               com.floragunn.searchguard.compliance.ComplianceConfig complianceConfig)
        Specified by:
        logDocumentWritten in interface com.floragunn.searchguard.auditlog.AuditLog

      • logDocumentDeleted

        public void logDocumentDeleted​(org.elasticsearch.index.shard.ShardId shardId,
                               org.elasticsearch.index.engine.Engine.Delete delete,
                               org.elasticsearch.index.engine.Engine.DeleteResult result)
        Specified by:
        logDocumentDeleted in interface com.floragunn.searchguard.auditlog.AuditLog

      • logExternalConfig

        public void logExternalConfig​(org.elasticsearch.common.settings.Settings settings,
                              org.elasticsearch.env.Environment environment)
        Specified by:
        logExternalConfig in interface com.floragunn.searchguard.auditlog.AuditLog