[RORDEV-1414] ES node details audit reporting

audit/src/main/scala/tech/beshu/ror/audit/AuditEnvironmentContext.scala

@@ -0,0 +1,20 @@
+/*
+ *    This file is part of ReadonlyREST.
+ *
+ *    ReadonlyREST is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    ReadonlyREST is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with ReadonlyREST.  If not, see http://www.gnu.org/licenses/
+ */
+package tech.beshu.ror.audit
+
+final case class AuditEnvironmentContext(esNodeName: String,
+                                         esClusterName: String)

audit/src/main/scala/tech/beshu/ror/audit/adapters/DeprecatedAuditLogSerializerAdapter.scala

@@ -19,7 +19,7 @@ package tech.beshu.ror.audit.adapters
 import org.json.JSONObject
 import tech.beshu.ror.audit.AuditResponseContext.{Allowed, Verbosity}
 import tech.beshu.ror.audit.instances.SerializeUser
-import tech.beshu.ror.audit.{AuditLogSerializer, AuditRequestContext, AuditResponseContext}
+import tech.beshu.ror.audit.{AuditEnvironmentContext, AuditLogSerializer, AuditRequestContext, AuditResponseContext}
 import tech.beshu.ror.commons.ResponseContext.FinalState
 import tech.beshu.ror.commons.shims.request.RequestContextShim
 

audit/src/main/scala/tech/beshu/ror/audit/instances/DefaultAuditLogSerializer.scala

@@ -16,83 +16,6 @@
  */
 package tech.beshu.ror.audit.instances
 
-import java.time.ZoneId
-import java.time.format.DateTimeFormatter
-import org.json.JSONObject
-import tech.beshu.ror.audit.AuditResponseContext._
-import tech.beshu.ror.audit.{AuditLogSerializer, AuditRequestContext, AuditResponseContext}
+import tech.beshu.ror.audit.AuditEnvironmentContext
 
-import scala.collection.JavaConverters._
-import scala.concurrent.duration.FiniteDuration
-
-class DefaultAuditLogSerializer extends AuditLogSerializer {
-
-  private val timestampFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss'Z'").withZone(ZoneId.of("GMT"))
-
-  override def onResponse(responseContext: AuditResponseContext): Option[JSONObject] = responseContext match {
-    case Allowed(requestContext, verbosity, reason) =>
-      verbosity match {
-        case Verbosity.Info =>
-          Some(createEntry(matched = true, "ALLOWED", reason, responseContext.duration, requestContext, None))
-        case Verbosity.Error =>
-          None
-      }
-    case ForbiddenBy(requestContext, _, reason) =>
-      Some(createEntry(matched = true, "FORBIDDEN", reason, responseContext.duration, requestContext, None))
-    case Forbidden(requestContext) =>
-      Some(createEntry(matched = false, "FORBIDDEN", "default", responseContext.duration, requestContext, None))
-    case RequestedIndexNotExist(requestContext) =>
-      Some(createEntry(matched = false, "INDEX NOT EXIST", "Requested index doesn't exist", responseContext.duration, requestContext, None))
-    case Errored(requestContext, cause) =>
-      Some(createEntry(matched = false, "ERRORED", "error", responseContext.duration, requestContext, Some(cause)))
-  }
-
-  private def createEntry(matched: Boolean,
-                          finalState: String,
-                          reason: String,
-                          duration: FiniteDuration,
-                          requestContext: AuditRequestContext,
-                          error: Option[Throwable]) = {
-    new JSONObject()
-      .put("match", matched)
-      .put("block", reason)
-      .put("id", requestContext.id)
-      .put("final_state", finalState)
-      .put("@timestamp", timestampFormatter.format(requestContext.timestamp))
-      .put("correlation_id", requestContext.correlationId)
-      .put("processingMillis", duration.toMillis)
-      .put("error_type", error.map(_.getClass.getSimpleName).orNull)
-      .put("error_message", error.map(_.getMessage).orNull)
-      .put("content_len", requestContext.contentLength)
-      .put("content_len_kb", requestContext.contentLength / 1024)
-      .put("type", requestContext.`type`)
-      .put("origin", requestContext.remoteAddress)
-      .put("destination", requestContext.localAddress)
-      .put("xff", requestContext.requestHeaders.getValue("X-Forwarded-For").flatMap(_.headOption).orNull)
-      .put("task_id", requestContext.taskId)
-      .put("req_method", requestContext.httpMethod)
-      .put("headers", requestContext.requestHeaders.names.asJava)
-      .put("path", requestContext.uriPath)
-      .put("user", SerializeUser.serialize(requestContext).orNull)
-      .put("impersonated_by", requestContext.impersonatedByUserName.orNull)
-      .put("action", requestContext.action)
-      .put("indices", if (requestContext.involvesIndices) requestContext.indices.toList.asJava else List.empty.asJava)
-      .put("acl_history", requestContext.history)
-      .mergeWith(requestContext.generalAuditEvents)
-  }
-
-  private implicit class JsonObjectOps(val mainJson: JSONObject) {
-    def mergeWith(secondaryJson: JSONObject): JSONObject = {
-      jsonKeys(secondaryJson).foldLeft(mainJson) {
-        case (json, name) if !json.has(name) =>
-          json.put(name, secondaryJson.get(name))
-        case (json, _) =>
-          json
-      }
-    }
-
-    private def jsonKeys(json: JSONObject) = {
-      Option(JSONObject.getNames(json)).toList.flatten
-    }
-  }
-}
+class DefaultAuditLogSerializer(environmentContext: AuditEnvironmentContext) extends DefaultAuditLogSerializerV2(environmentContext)

audit/src/main/scala/tech/beshu/ror/audit/instances/DefaultAuditLogSerializerV1.scala

@@ -0,0 +1,98 @@
+/*
+ *    This file is part of ReadonlyREST.
+ *
+ *    ReadonlyREST is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    ReadonlyREST is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with ReadonlyREST.  If not, see http://www.gnu.org/licenses/
+ */
+package tech.beshu.ror.audit.instances
+
+import org.json.JSONObject
+import tech.beshu.ror.audit.AuditResponseContext._
+import tech.beshu.ror.audit.{AuditEnvironmentContext, AuditLogSerializer, AuditRequestContext, AuditResponseContext}
+
+import java.time.ZoneId
+import java.time.format.DateTimeFormatter
+import scala.collection.JavaConverters._
+import scala.concurrent.duration.FiniteDuration
+
+class DefaultAuditLogSerializerV1 extends AuditLogSerializer {
+
+  private val timestampFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss'Z'").withZone(ZoneId.of("GMT"))
+
+  override def onResponse(responseContext: AuditResponseContext): Option[JSONObject] = responseContext match {
+    case Allowed(requestContext, verbosity, reason) =>
+      verbosity match {
+        case Verbosity.Info =>
+          Some(createEntry(matched = true, "ALLOWED", reason, responseContext.duration, requestContext, None))
+        case Verbosity.Error =>
+          None
+      }
+    case ForbiddenBy(requestContext, _, reason) =>
+      Some(createEntry(matched = true, "FORBIDDEN", reason, responseContext.duration, requestContext, None))
+    case Forbidden(requestContext) =>
+      Some(createEntry(matched = false, "FORBIDDEN", "default", responseContext.duration, requestContext, None))
+    case RequestedIndexNotExist(requestContext) =>
+      Some(createEntry(matched = false, "INDEX NOT EXIST", "Requested index doesn't exist", responseContext.duration, requestContext, None))
+    case Errored(requestContext, cause) =>
+      Some(createEntry(matched = false, "ERRORED", "error", responseContext.duration, requestContext, Some(cause)))
+  }
+
+  private def createEntry(matched: Boolean,
+                          finalState: String,
+                          reason: String,
+                          duration: FiniteDuration,
+                          requestContext: AuditRequestContext,
+                          error: Option[Throwable]) = {
+    new JSONObject()
+      .put("match", matched)
+      .put("block", reason)
+      .put("id", requestContext.id)
+      .put("final_state", finalState)
+      .put("@timestamp", timestampFormatter.format(requestContext.timestamp))
+      .put("correlation_id", requestContext.correlationId)
+      .put("processingMillis", duration.toMillis)
+      .put("error_type", error.map(_.getClass.getSimpleName).orNull)
+      .put("error_message", error.map(_.getMessage).orNull)
+      .put("content_len", requestContext.contentLength)
+      .put("content_len_kb", requestContext.contentLength / 1024)
+      .put("type", requestContext.`type`)
+      .put("origin", requestContext.remoteAddress)
+      .put("destination", requestContext.localAddress)
+      .put("xff", requestContext.requestHeaders.getValue("X-Forwarded-For").flatMap(_.headOption).orNull)
+      .put("task_id", requestContext.taskId)
+      .put("req_method", requestContext.httpMethod)
+      .put("headers", requestContext.requestHeaders.names.asJava)
+      .put("path", requestContext.uriPath)
+      .put("user", SerializeUser.serialize(requestContext).orNull)
+      .put("impersonated_by", requestContext.impersonatedByUserName.orNull)
+      .put("action", requestContext.action)
+      .put("indices", if (requestContext.involvesIndices) requestContext.indices.toList.asJava else List.empty.asJava)
+      .put("acl_history", requestContext.history)
+      .mergeWith(requestContext.generalAuditEvents)
+  }
+
+  private implicit class JsonObjectOps(val mainJson: JSONObject) {
+    def mergeWith(secondaryJson: JSONObject): JSONObject = {
+      jsonKeys(secondaryJson).foldLeft(mainJson) {
+        case (json, name) if !json.has(name) =>
+          json.put(name, secondaryJson.get(name))
+        case (json, _) =>
+          json
+      }
+    }
+
+    private def jsonKeys(json: JSONObject) = {
+      Option(JSONObject.getNames(json)).toList.flatten
+    }
+  }
+}

audit/src/main/scala/tech/beshu/ror/audit/instances/DefaultAuditLogSerializerV2.scala

@@ -0,0 +1,32 @@
+/*
+ *    This file is part of ReadonlyREST.
+ *
+ *    ReadonlyREST is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    ReadonlyREST is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with ReadonlyREST.  If not, see http://www.gnu.org/licenses/
+ */
+package tech.beshu.ror.audit.instances
+
+import org.json.JSONObject
+import tech.beshu.ror.audit.{AuditEnvironmentContext, AuditResponseContext}
+
+class DefaultAuditLogSerializerV2(environmentContext: AuditEnvironmentContext) extends DefaultAuditLogSerializerV1 {
+
+  override def onResponse(responseContext: AuditResponseContext): Option[JSONObject] = {
+    lazy val additionalFields = Map(
+      "es_node_name" -> environmentContext.esNodeName,
+      "es_cluster_name" -> environmentContext.esClusterName
+    )
+    super.onResponse(responseContext)
+      .map(additionalFields.foldLeft(_) { case (soFar, (key, value)) => soFar.put(key, value) })
+  }
+}

audit/src/main/scala/tech/beshu/ror/audit/instances/QueryAuditLogSerializer.scala

@@ -16,13 +16,6 @@
  */
 package tech.beshu.ror.audit.instances
 
-import org.json.JSONObject
-import tech.beshu.ror.audit.AuditResponseContext
+import tech.beshu.ror.audit.AuditEnvironmentContext
 
-class QueryAuditLogSerializer extends DefaultAuditLogSerializer {
-
-  override def onResponse(responseContext: AuditResponseContext): Option[JSONObject] = {
-    super.onResponse(responseContext)
-      .map(_.put("content", responseContext.requestContext.content))
-  }
-}
+class QueryAuditLogSerializer(environmentContext: AuditEnvironmentContext) extends QueryAuditLogSerializerV2(environmentContext)

audit/src/main/scala/tech/beshu/ror/audit/instances/QueryAuditLogSerializerV1.scala

@@ -0,0 +1,28 @@
+/*
+ *    This file is part of ReadonlyREST.
+ *
+ *    ReadonlyREST is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    ReadonlyREST is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with ReadonlyREST.  If not, see http://www.gnu.org/licenses/
+ */
+package tech.beshu.ror.audit.instances
+
+import org.json.JSONObject
+import tech.beshu.ror.audit.{AuditEnvironmentContext, AuditResponseContext}
+
+class QueryAuditLogSerializerV1 extends DefaultAuditLogSerializerV1 {
+
+  override def onResponse(responseContext: AuditResponseContext): Option[JSONObject] = {
+    super.onResponse(responseContext)
+      .map(_.put("content", responseContext.requestContext.content))
+  }
+}

audit/src/main/scala/tech/beshu/ror/audit/instances/QueryAuditLogSerializerV2.scala

@@ -0,0 +1,29 @@
+/*
+ *    This file is part of ReadonlyREST.
+ *
+ *    ReadonlyREST is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    ReadonlyREST is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with ReadonlyREST.  If not, see http://www.gnu.org/licenses/
+ */
+package tech.beshu.ror.audit.instances
+
+import org.json.JSONObject
+import tech.beshu.ror.audit.{AuditEnvironmentContext, AuditResponseContext}
+
+class QueryAuditLogSerializerV2(environmentContext: AuditEnvironmentContext) extends DefaultAuditLogSerializerV2(environmentContext) {
+
+  override def onResponse(responseContext: AuditResponseContext,
+                          ): Option[JSONObject] = {
+    super.onResponse(responseContext)
+      .map(_.put("content", responseContext.requestContext.content))
+  }
+}