pii

Documentation

Index

• Constants
• func EffectiveMode(mode string, allowUnredacted bool, unredacted bool) (string, error)
• func IsEnabled(mode string) bool
• func IsValidMode(v string) bool
• func NormalizeMode(v string) string
• func ShouldRedactType(mode, entityType string) bool
• type Engine
  • func NewEngine(mode, secret string, opts ...EngineOption) *Engine
  • func (e *Engine) Enabled() bool
  • func (e *Engine) Mode() string
  • func (e *Engine) RedactEmail(email string) string
  • func (e *Engine) RedactJSON(data json.RawMessage) (json.RawMessage, error)
  • func (e *Engine) RedactPerson(first, last, email string) (string, string, string)
  • func (e *Engine) RedactPhone(phone string) string
  • func (e *Engine) RedactText(text string, known []KnownIdentity) string
  • func (e *Engine) ShouldRedactType(entityType string) bool
• type EngineOption
  • func WithNER(d NameDetector) EngineOption
• type KnownIdentity
• type NameDetector
• type NameSpan

Constants

const (
	ModeOff       = "off"
	ModeCustomers = "customers"
	ModeAll       = "all"
)

const RedactTextNotice = `[redacted — run "hs pii-model install" for content]`

RedactTextNotice is shown for freeform text when NER is not installed.

Functions

func EffectiveMode

func EffectiveMode(mode string, allowUnredacted bool, unredacted bool) (string, error)

EffectiveMode applies per-request override policy.

func IsEnabled

func IsEnabled(mode string) bool

func IsValidMode

func IsValidMode(v string) bool

func NormalizeMode

func NormalizeMode(v string) string

NormalizeMode normalizes configured mode values.

func ShouldRedactType

func ShouldRedactType(mode, entityType string) bool

ShouldRedactType decides whether an entity type should be redacted for mode. entityType is expected to be "customer" or "user". Unknown types are only redacted in "all" mode.

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine(mode, secret string, opts ...EngineOption) *Engine

func (*Engine) Enabled

func (e *Engine) Enabled() bool

func (*Engine) Mode

func (e *Engine) Mode() string

func (*Engine) RedactEmail

func (e *Engine) RedactEmail(email string) string

func (*Engine) RedactJSON

func (e *Engine) RedactJSON(data json.RawMessage) (json.RawMessage, error)

func (*Engine) RedactPerson

func (e *Engine) RedactPerson(first, last, email string) (string, string, string)

func (*Engine) RedactPhone

func (e *Engine) RedactPhone(phone string) string

func (*Engine) RedactText

func (e *Engine) RedactText(text string, known []KnownIdentity) string

RedactText redacts free-form text using known identities followed by regex sweeps. When NER is available, names are detected via ML. Without NER, freeform text is hidden entirely (structured field redaction still works).

In mode-restricted operation (e.g. "customers"), only identities whose Type matches the mode are redacted; other known identities are "protected" so neither redactKnown nor NER replaces them.

func (*Engine) ShouldRedactType

func (e *Engine) ShouldRedactType(entityType string) bool

type EngineOption

type EngineOption func(*Engine)

EngineOption configures optional Engine behaviour.

func WithNER

func WithNER(d NameDetector) EngineOption

WithNER attaches a name detector for freeform text redaction.

type KnownIdentity

type KnownIdentity struct {
	Type  string
	First string
	Last  string
	Email string
	Phone string
}

type NameDetector

type NameDetector interface {
	DetectNames(text string) ([]NameSpan, error)
}

NameDetector detects person names in free-form text.

type NameSpan

type NameSpan struct {
	Text  string
	Start int
	End   int
	Score float32
}

NameSpan represents a detected name in text.