Insider.Finding (Insider v0.1.0)

Copy Markdown View Source

A bounded detector-neutral finding with statically validated details.

Detector names remain strings at the trust boundary. Support is selected by literal detector/version clauses; external data never selects a module or creates an atom.

Summary

Types

t()

@type t() :: %Insider.Finding{
  confidence: term(),
  details: term(),
  detector: term(),
  detector_version: term(),
  evidence_event_ids: term(),
  fingerprint: term(),
  occurred_at_us: term(),
  schema: term(),
  severity: term(),
  trigger_event_id: term()
}

Functions

decode_map(wire)

@spec decode_map(term()) :: {:ok, t()} | {:error, Insider.Protocol.Error.t()}

evidence_event_fingerprint(event)

@spec evidence_event_fingerprint(Insider.Event.t() | map()) ::
  {:ok, String.t()} | {:error, Insider.Protocol.Error.t()}

Returns the canonical digest that binds one exact evidence event to a finding.

new(options)

@spec new(keyword()) :: {:ok, t()} | {:error, Insider.Protocol.Error.t()}

new!(options)

@spec new!(keyword()) :: t()

to_wire_map(finding)

@spec to_wire_map(t()) :: map()

valid_wire?(wire)

@spec valid_wire?(term()) :: boolean()

validate(finding)

@spec validate(term()) :: {:ok, t()} | {:error, Insider.Protocol.Error.t()}