Lightning.Scrubber (Lightning v2.15.0-pre5)

View Source

Process used to scrub strings of sensitive information.

Can be started via start_link/1.

{:ok, scrubber} =
  Lightning.Scrubber.start_link(
    samples:
      Lightning.Credentials.sensitive_values_for(credential)
  )

Takes an optional :name key, in case you need to name the process.

Summary

Functions

add_samples(agent, new_samples, basic_auth)
child_spec(arg)

Returns a specification to start this module under a supervisor.

encode_samples(samples, basic_auth \\ [])

Prepare a list of sensitive samples (strings) into a potentially bigger list composed of variations a sample may appear.

samples(agent)
scrub(agent, lines)

This is used for scrubbing logs (is_list) and JSON (is_binary)

scrub_values(value, array_limit \\ 2)

Recursively scrubs all values from a data structure, replacing them with type placeholders. Preserves keys and structure while hiding actual values. Arrays are sampled up to array_limit elements with a "...N more" indicator if truncated.

start_link(opts)

Functions

add_samples(agent, new_samples, basic_auth)

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

encode_samples(samples, basic_auth \\ [])

@spec encode_samples(samples :: [String.t()], basic_auth :: [String.t()]) :: [
  String.t()
]

Prepare a list of sensitive samples (strings) into a potentially bigger list composed of variations a sample may appear.

samples(agent)

scrub(agent, lines)

This is used for scrubbing logs (is_list) and JSON (is_binary)

scrub_values(value, array_limit \\ 2)

@spec scrub_values(any(), non_neg_integer()) :: any()

Recursively scrubs all values from a data structure, replacing them with type placeholders. Preserves keys and structure while hiding actual values. Arrays are sampled up to array_limit elements with a "...N more" indicator if truncated.

Examples

iex> scrub_values(%{"name" => "John", "age" => 30})
%{"name" => "string", "age" => "number"}

iex> scrub_values([1, 2, 3])
["number", "number", "...1 more"]

start_link(opts)

@spec start_link(
  opts :: [
    samples: [String.t()],
    basic_auth: [String.t()],
    name: nil | GenServer.name()
  ]
) :: Agent.on_start()