-
Notifications
You must be signed in to change notification settings - Fork 640
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#1619 Add the trigger "CaseShared" and the responders "RunAnalyzer" a…
…nd "RunResponder"
- Loading branch information
Showing
8 changed files
with
248 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
.../scala/org/thp/thehive/connector/cortex/services/notification/notifiers/RunAnalyzer.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| package org.thp.thehive.connector.cortex.services.notification.notifiers | ||
|
|
||
| import javax.inject.{Inject, Singleton} | ||
| import org.apache.tinkerpop.gremlin.structure.Graph | ||
| import org.thp.scalligraph.models.Entity | ||
| import org.thp.scalligraph.traversal.TraversalOps._ | ||
| import org.thp.scalligraph.{BadConfigurationError, NotFoundError, RichOption} | ||
| import org.thp.thehive.connector.cortex.services.{AnalyzerSrv, JobSrv} | ||
| import org.thp.thehive.controllers.v0.AuditRenderer | ||
| import org.thp.thehive.models._ | ||
| import org.thp.thehive.services.ObservableOps._ | ||
| import org.thp.thehive.services._ | ||
| import org.thp.thehive.services.notification.notifiers.{Notifier, NotifierProvider} | ||
| import play.api.Configuration | ||
|
|
||
| import scala.concurrent.{ExecutionContext, Future} | ||
| import scala.util.{Failure, Try} | ||
|
|
||
| @Singleton | ||
| class RunAnalyzerProvider @Inject() ( | ||
| analyzerSrv: AnalyzerSrv, | ||
| jobSrv: JobSrv, | ||
| caseSrv: CaseSrv, | ||
| observableSrv: ObservableSrv, | ||
| ec: ExecutionContext | ||
| ) extends NotifierProvider { | ||
| override val name: String = "RunAnalyzer" | ||
|
|
||
| override def apply(config: Configuration): Try[Notifier] = | ||
| config.getOrFail[String]("analyzerName").map { responderName => | ||
| new RunAnalyzer( | ||
| responderName, | ||
| analyzerSrv, | ||
| jobSrv, | ||
| caseSrv, | ||
| observableSrv, | ||
| ec | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| class RunAnalyzer( | ||
| analyzerName: String, | ||
| analyzerSrv: AnalyzerSrv, | ||
| jobSrv: JobSrv, | ||
| caseSrv: CaseSrv, | ||
| observableSrv: ObservableSrv, | ||
| implicit val ec: ExecutionContext | ||
| ) extends Notifier | ||
| with AuditRenderer { | ||
| override val name: String = "RunAnalyzer" | ||
|
|
||
| def getObservable(`object`: Option[Entity])(implicit graph: Graph): Future[RichObservable] = | ||
| `object` match { | ||
| case Some(o) if o._label == "Observable" => Future.fromTry(observableSrv.get(o._id).richObservable.getOrFail("Observable")) | ||
| case _ => Future.failed(NotFoundError("Audit object is not an observable")) | ||
| } | ||
|
|
||
| def getCase(context: Option[Entity])(implicit graph: Graph): Future[Case with Entity] = | ||
| context match { | ||
| case Some(c) if c._label == "Case" => Future.fromTry(caseSrv.getOrFail(c._id)) | ||
| case _ => Future.failed(NotFoundError("Audit context is not a case")) | ||
| } | ||
|
|
||
| override def execute( | ||
| audit: Audit with Entity, | ||
| context: Option[Entity], | ||
| `object`: Option[Entity], | ||
| organisation: Organisation with Entity, | ||
| user: Option[User with Entity] | ||
| )(implicit graph: Graph): Future[Unit] = | ||
| if (user.isDefined) | ||
| Future.failed(BadConfigurationError("The notification runAnalyzer must not be applied on user")) | ||
| else | ||
| for { | ||
| observable <- getObservable(`object`) | ||
| case0 <- getCase(context) | ||
| workers <- analyzerSrv.getAnalyzerByName(analyzerName, organisation._id) | ||
| (worker, cortexIds) <- Future.fromTry(workers.headOption.toTry(Failure(NotFoundError(s"Analyzer $analyzerName not found")))) | ||
| authContext = LocalUserSrv.getSystemAuthContext.changeOrganisation(organisation._id, Permissions.all) | ||
| _ <- jobSrv.submit(cortexIds.head, worker.id, observable, case0)(authContext) | ||
| } yield () | ||
| } |
100 changes: 100 additions & 0 deletions
100
...scala/org/thp/thehive/connector/cortex/services/notification/notifiers/RunResponder.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| package org.thp.thehive.connector.cortex.services.notification.notifiers | ||
|
|
||
| import com.typesafe.config.ConfigRenderOptions | ||
| import javax.inject.{Inject, Singleton} | ||
| import org.apache.tinkerpop.gremlin.structure.Graph | ||
| import org.thp.scalligraph.models.Entity | ||
| import org.thp.scalligraph.traversal.TraversalOps._ | ||
| import org.thp.scalligraph.{BadConfigurationError, NotFoundError, RichOption} | ||
| import org.thp.thehive.connector.cortex.services.{ActionSrv, ResponderSrv} | ||
| import org.thp.thehive.controllers.v0.AuditRenderer | ||
| import org.thp.thehive.models.{Audit, Organisation, Permissions, User} | ||
| import org.thp.thehive.services._ | ||
| import org.thp.thehive.services.notification.notifiers.{Notifier, NotifierProvider} | ||
| import play.api.Configuration | ||
| import play.api.libs.json.{JsObject, Json, OWrites} | ||
|
|
||
| import scala.concurrent.{ExecutionContext, Future} | ||
| import scala.util.{Failure, Try} | ||
|
|
||
| @Singleton | ||
| class RunResponderProvider @Inject() ( | ||
| responderSrv: ResponderSrv, | ||
| actionSrv: ActionSrv, | ||
| taskSrv: TaskSrv, | ||
| caseSrv: CaseSrv, | ||
| observableSrv: ObservableSrv, | ||
| logSrv: LogSrv, | ||
| alertSrv: AlertSrv, | ||
| ec: ExecutionContext | ||
| ) extends NotifierProvider { | ||
| override val name: String = "RunResponder" | ||
|
|
||
| override def apply(config: Configuration): Try[Notifier] = { | ||
|
|
||
| val parameters = Try(Json.parse(config.underlying.getValue("parameters").render(ConfigRenderOptions.concise())).as[JsObject]).toOption | ||
| config.getOrFail[String]("responderName").map { responderName => | ||
| new RunResponder( | ||
| responderName, | ||
| parameters.getOrElse(JsObject.empty), | ||
| responderSrv, | ||
| actionSrv, | ||
| taskSrv, | ||
| caseSrv, | ||
| observableSrv, | ||
| logSrv, | ||
| alertSrv, | ||
| ec | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class RunResponder( | ||
| responderName: String, | ||
| parameters: JsObject, | ||
| responderSrv: ResponderSrv, | ||
| actionSrv: ActionSrv, | ||
| taskSrv: TaskSrv, | ||
| caseSrv: CaseSrv, | ||
| observableSrv: ObservableSrv, | ||
| logSrv: LogSrv, | ||
| alertSrv: AlertSrv, | ||
| implicit val ec: ExecutionContext | ||
| ) extends Notifier | ||
| with AuditRenderer { | ||
| override val name: String = "RunResponder" | ||
|
|
||
| def getEntity(audit: Audit)(implicit graph: Graph): Try[(Product with Entity, JsObject)] = | ||
| audit | ||
| .objectEntityId | ||
| .flatMap { objectId => | ||
| audit.objectType.map { | ||
| case "Task" => taskSrv.get(objectId).project(_.by.by(taskToJson)).getOrFail("Task") | ||
| case "Case" => caseSrv.get(objectId).project(_.by.by(caseToJson)).getOrFail("Case") | ||
| case "Observable" => observableSrv.get(objectId).project(_.by.by(observableToJson)).getOrFail("Observable") | ||
| case "Log" => logSrv.get(objectId).project(_.by.by(logToJson)).getOrFail("Log") | ||
| case "Alert" => alertSrv.get(objectId).project(_.by.by(alertToJson)).getOrFail("Alert") | ||
| case objectType => Failure(NotFoundError(s"objectType $objectType is not recognised")) | ||
| } | ||
| } | ||
| .getOrElse(Failure(NotFoundError("Object not present in the audit"))) | ||
|
|
||
| override def execute( | ||
| audit: Audit with Entity, | ||
| context: Option[Entity], | ||
| `object`: Option[Entity], | ||
| organisation: Organisation with Entity, | ||
| user: Option[User with Entity] | ||
| )(implicit graph: Graph): Future[Unit] = | ||
| if (user.isDefined) | ||
| Future.failed(BadConfigurationError("The notification runResponder must not be applied on user")) | ||
| else | ||
| for { | ||
| (entity, entityJson) <- Future.fromTry(getEntity(audit)) | ||
| workers <- responderSrv.getRespondersByName(responderName, organisation._id) | ||
| (worker, cortexIds) <- Future.fromTry(workers.headOption.toTry(Failure(NotFoundError(s"Responder $responderName not found")))) | ||
| authContext = LocalUserSrv.getSystemAuthContext.changeOrganisation(organisation._id, Permissions.all) | ||
| _ <- actionSrv.execute(entity, cortexIds.headOption, worker.id, parameters)(OWrites[Entity](_ => entityJson), authContext) | ||
| } yield () | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
thehive/app/org/thp/thehive/services/notification/triggers/CaseShared.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| package org.thp.thehive.services.notification.triggers | ||
|
|
||
| import javax.inject.{Inject, Singleton} | ||
| import org.thp.scalligraph.models.Entity | ||
| import org.thp.thehive.models.{Audit, Organisation} | ||
| import play.api.Configuration | ||
| import play.api.libs.json.Json | ||
|
|
||
| import scala.util.{Success, Try} | ||
|
|
||
| @Singleton | ||
| class CaseShareProvider @Inject() extends TriggerProvider { | ||
| override val name: String = "CaseShared" | ||
| override def apply(config: Configuration): Try[Trigger] = Success(new CaseShared()) | ||
| } | ||
|
|
||
| class CaseShared() extends Trigger { | ||
| override val name: String = "CaseShared" | ||
|
|
||
| override def preFilter(audit: Audit with Entity, context: Option[Entity], organisation: Organisation with Entity): Boolean = | ||
| audit.action == Audit.update && audit | ||
| .objectType | ||
| .contains("Case") && audit.details.flatMap(d => Try(Json.parse(d)).toOption).exists(d => (d \ "share").isDefined) | ||
| } |