pii

Documentation

Index

• Constants
• type Detector
• type DetectorImpl
  • func NewDetector(opts ...Option) *DetectorImpl
  • func (fp *DetectorImpl) Sanitize(input string, tokens []Token) string
  • func (fp *DetectorImpl) Tokenize(input string) ([]Token, error)
• type Option
  • func WithDetectionStats(stats telemetry.DeferrableCounter) Option
  • func WithPIITypes(types ...PIIType) Option
  • func WithRedactedReplacement(replacement string) Option
  • func WithRedactionStats(stats telemetry.DeferrableCounter) Option
• type PIIType
  • func (t PIIType) String() string
• type Token

Constants

const (
	PIITypeEmail = PIIType(tokenizer.TokenEmail)
	PIITypeIPv4  = PIIType(tokenizer.TokenIPv4)
	PIITypeURL   = PIIType(tokenizer.TokenURL)
	PIITypeFQDN  = PIIType(tokenizer.TokenFQDN)
	PIITypePhone = PIIType(tokenizer.TokenPhone)
	PIITypeSSN   = PIIType(tokenizer.TokenSSN)
	PIITypeCCN   = PIIType(tokenizer.TokenCCN)
)

Types

type Detector

type Detector interface {
	Tokenize(input string) ([]Token, error)
	Sanitize(input string, tokens []Token) string
}

type DetectorImpl

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

func NewDetector

func NewDetector(opts ...Option) *DetectorImpl

func (*DetectorImpl) Sanitize

func (fp *DetectorImpl) Sanitize(input string, tokens []Token) string

func (*DetectorImpl) Tokenize

func (fp *DetectorImpl) Tokenize(input string) ([]Token, error)

type Option

type Option func(*DetectorImpl)

func WithDetectionStats

func WithDetectionStats(stats telemetry.DeferrableCounter) Option

func WithPIITypes

func WithPIITypes(types ...PIIType) Option

func WithRedactedReplacement

func WithRedactedReplacement(replacement string) Option

func WithRedactionStats

func WithRedactionStats(stats telemetry.DeferrableCounter) Option

type PIIType

type PIIType int

func (PIIType) String

func (t PIIType) String() string

type Token

type Token struct {
	Type  PIIType
	Value string
}