Obscura (obscura v0.1.0)

Obscura is a library-first privacy toolkit for Elixir.

Public APIs return explicit success or error tuples.

Summary

Analyzes a string for supported PII entities.

Analyzes multiple strings while preserving input order.

Applies anonymization operators to analyzer results or fixture-compatible spans.

Analyzes and anonymizes a string in one call.

Rehydrates vault-backed pseudonym tokens in strings or supported structured data.

@spec analyze(
  String.t(),
  keyword()
) :: {:ok, [Obscura.Analyzer.Result.t()]} | {:error, term()}

Analyzes a string for supported PII entities.

@spec analyze_many(
  [String.t()],
  keyword()
) :: {:ok, [[Obscura.Analyzer.Result.t()]]} | {:error, term()}

Analyzes multiple strings while preserving input order.

@spec anonymize(String.t(), [map() | struct()], keyword()) ::
  {:ok, Obscura.Anonymizer.Result.t()} | {:error, term()}

Applies anonymization operators to analyzer results or fixture-compatible spans.

@spec redact(
  String.t(),
  keyword()
) :: {:ok, Obscura.Anonymizer.Result.t()} | {:error, term()}

Analyzes and anonymizes a string in one call.

@spec rehydrate(
  term(),
  keyword()
) :: {:ok, term()} | {:error, term()}

Rehydrates vault-backed pseudonym tokens in strings or supported structured data.