VulnCheck.Types.ModuleSummary (VulnCheck v1.0.1)

Copy Markdown View Source

Everything the analyzer needs to know about one compiled module.

Summaries contain only strings, integers, lists, maps and atoms defined by VulnCheck itself, so they can be cached with :erlang.term_to_binary/1 and decoded with :erlang.binary_to_term(bin, [:safe]).

module_refs lists module names that appear as literals inside a function (children of supervisors, plugs passed as options, adapters, ...). init_literals keeps the literal arguments of selected framework calls (for example Plug.Parsers.init/1) in the string-based literal encoding of VulnCheck.Beam.AbstractWalker.

Summary

Types

literal()

@type literal() ::
  {:atom, String.t()}
  | {:tuple, [literal()]}
  | {:map, [{literal(), literal()}]}
  | {:fun, String.t()}
  | [literal()]
  | binary()
  | number()
  | :dynamic

t()

@type t() :: %VulnCheck.Types.ModuleSummary{
  attributes: %{required(String.t()) => term()},
  beam_path: String.t() | nil,
  behaviours: [String.t()],
  dynamic_dispatches: [VulnCheck.Types.DynamicCall.t()],
  edges: [VulnCheck.Types.CallEdge.t()],
  exports: [{String.t(), non_neg_integer()}],
  function_lines: %{required({String.t(), non_neg_integer()}) => pos_integer()},
  functions: [{String.t(), non_neg_integer()}],
  has_debug_info: boolean(),
  imports: [{String.t(), String.t(), non_neg_integer()}],
  init_literals: [
    {VulnCheck.Types.MFA.t(), VulnCheck.Types.MFA.t(), [literal()],
     String.t() | nil, non_neg_integer() | nil}
  ],
  mfa_refs: [VulnCheck.Types.CallEdge.t()],
  module: String.t(),
  module_refs: [
    {VulnCheck.Types.MFA.t(), String.t(), String.t() | nil,
     non_neg_integer() | nil}
  ],
  package: String.t() | nil,
  sha256: String.t() | nil,
  source_file: String.t() | nil
}