scrubbing

type Disposition string

type FieldNameRule struct {
	// In is a field-name matching pattern to test whether this rule applied.
	In *regexp.Regexp
	// Out describes what to do when a value satisfies this rule.
	Out Disposition
}

type HeuristicRule struct {
	// In is the name of a model that will be used to recognize values.
	In string

	P float64
	// Out describes what to do when a value satisfies this rule.
	Out Disposition
}

type Percentage float64

type Policy struct {
	// FieldName ensures that certain fields are always scrubbed based on their name.
	// Key: substring of a field name
	// Value: disposition when fields matching this substring are encountered
	FieldName []FieldNameRule `json:"fieldname"`
	// Heuristic applies selected models heuristically to all values to achieve
	// scrubbing based on the type, shape of pattern of the value itself.
	// Key: model name
	// Value: disposition when a value matches the model
	Heuristic []HeuristicRule `json:"heuristic"`
}

type Report struct {
	// FieldName contains statistics about each field-name rule.
	FieldName []RuleReport
	// Heuristic contains statistics about each heuristic rule.
	Heuristic []RuleReport
	Summary   SummaryReport
}

type RuleReport struct {
	// Defn is the rule definition expressed as a string with compact, human-readable notation.
	Defn string
	// Fields is a list of distinct field names that were handled by a particular rule.
	Fields []string
	// Freq records the frequency (0-100%) with which this rule was applied.
	Freq Percentage
	// Safe determines the frequency of sanitized outputs that did not coincide with any input.
	//   100% => absolutely no overlap (output is perfectly sanitized)
	//     0% => complete overlap (output is effectively NOT sanitized, even if values are transposed; DANGER!)
	Safe Percentage
}

type Scrubber struct {
	Verifier *Verifier
	// contains filtered or unexported fields
}

type SummaryReport struct {
	Load Percentage
	Safe Percentage
}

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