model

type Category string

type CategoryInfo struct {
	Label    string
	Severity Severity
	Mask     string
}

type Column struct {
	Name       string
	Position   int
	DataType   string // lower case, e.g. varchar, bigint, longtext
	ColumnType string // full type, e.g. "bigint(20) unsigned"
	Nullable   bool
	// MaxLength is how many characters a string column holds, or bytes for a
	// binary one (CHARACTER_MAXIMUM_LENGTH). OctetLength is how many bytes
	// it holds (CHARACTER_OCTET_LENGTH). Both are 0 for numbers, dates and
	// other types that aren't strings; ENUM and SET columns have them.
	MaxLength   int64
	OctetLength int64
	// Charset and Collation are a string column's character set and
	// collation, such as utf8mb4 and utf8mb4_unicode_520_ci, ENUM and SET
	// columns included. They are empty for other types, binary strings
	// included.
	Charset   string
	Collation string
	Key       string // PRI, UNI, MUL
	Extra     string // auto_increment, VIRTUAL GENERATED, ...
	Comment   string
}

type Confidence int

type Finding struct {
	Table  string `json:"table"`
	Column string `json:"column"`
	// MetaKey is a key of a key/value table, or a pattern such as
	// um_cache_userdata_* where * stands for the part that varies between
	// keys. The varying part may itself be data, so it is never shown.
	MetaKey string `json:"meta_key,omitempty"`
	// KeyName marks a finding about the key names themselves: Column is
	// the key column, and the part of the names matched by * holds data.
	KeyName bool `json:"key_name,omitempty"`
	// Keys is how many keys a pattern stands for; KeysPartial says the
	// count is a lower bound because the keys were sampled, not listed.
	Keys        int    `json:"keys,omitempty"`
	KeysPartial bool   `json:"keys_partial,omitempty"`
	Path        string `json:"path,omitempty"`
	// Where, when set, limits the finding to the rows that match it, such
	// as the privacy requests among WordPress posts.
	Where      string     `json:"where,omitempty"`
	Category   Category   `json:"category"`
	Severity   Severity   `json:"severity"`
	Confidence Confidence `json:"confidence"`
	Sampled    int        `json:"sampled"`
	Matched    int        `json:"matched"`
	Reasons    []string   `json:"reasons"`
	Mask       string     `json:"suggested_mask"`
	RowMasks   []RowMask  `json:"suggested_row_masks,omitempty"`
	Source     string     `json:"source"`
	Note       string     `json:"note,omitempty"`
}

type ForeignKey struct {
	Name       string
	Columns    []string
	RefSchema  string
	RefTable   string
	RefColumns []string
}

type Index struct {
	Name    string
	Unique  bool
	Type    string // BTREE, HASH, FULLTEXT or SPATIAL (information_schema INDEX_TYPE)
	Columns []string
	// SubParts holds, per column, the length of an indexed prefix, or 0
	// when the whole column is indexed (information_schema SUB_PART).
	SubParts []int
}

type IndexUse struct {
	Found  bool // some index starts with the column
	Full   bool // one of them indexes the whole column, not a prefix of it
	Unique bool // a unique index covers exactly this column, in full
}

type LeakAllowed struct {
	Domains       []string `json:"domains"`
	Addresses     int      `json:"addresses"`
	ValuesSkipped int64    `json:"values_skipped"`
}

type LeakColumn struct {
	Table    string   `json:"table"`
	Column   string   `json:"column"`
	MetaKey  string   `json:"meta_key,omitempty"`
	Kind     LeakKind `json:"kind"`
	Severity Severity `json:"severity"`
	State    string   `json:"state"`
	// StoppedBy says what stopped the column: "--max-time" or an error's
	// description, which never quotes the server's message.
	StoppedBy string `json:"stopped_by,omitempty"`
	Excepted  bool   `json:"excepted_from_fail_on,omitempty"`
	// Line is the report's line about this column.
	Line string `json:"line"`

	// From production.
	Sample          string `json:"sample"`
	Exact           bool   `json:"every_value_sampled,omitempty"`
	Sampled         int    `json:"sampled"`
	EstimatedValues int64  `json:"production_values_estimate"`

	// From staging.
	Found         int   `json:"found"`
	Rows          int64 `json:"rows_holding_them"`
	Values        int64 `json:"values_read"`
	ValuesSkipped int64 `json:"values_skipped_by_allow_email,omitempty"`
	RowsRead      int64 `json:"rows_read"`
	RowsEstimate  int64 `json:"rows_estimate"`

	// What the numbers say, each 0 where it doesn't apply.
	ShownAt95      float64 `json:"real_values_shown_at_95_percent,omitempty"`
	CatchIfAllReal float64 `json:"chance_of_catching_if_all_read_were_real,omitempty"`
	ChanceMatches  float64 `json:"matches_chance_could_explain,omitempty"`
	EstimateInAll  int64   `json:"estimated_real_values_in_all,omitempty"`
}

type LeakHashesInfo struct {
	Database    string    `json:"database"`
	CreatedAt   time.Time `json:"created_at"`
	ToolVersion string    `json:"tool_version"`
	SampleRows  int       `json:"sample_rows"`
}

type LeakKind string

type LeakLeftOut struct {
	Location string `json:"location"`
	Why      string `json:"why"`
	NotRead  bool   `json:"not_read,omitempty"`
	Excepted bool   `json:"excepted_from_fail_on,omitempty"`
}

type LeakResult struct {
	Tool        string         `json:"tool"`
	Version     string         `json:"version"`
	GeneratedAt time.Time      `json:"generated_at"`
	Server      ServerInfo     `json:"server"`
	Database    string         `json:"database"`
	Hashes      LeakHashesInfo `json:"hashes"`
	Allowed     LeakAllowed    `json:"allowed"`
	Summary     LeakSummary    `json:"summary"`
	Columns     []LeakColumn   `json:"columns"`
	LeftOut     []LeakLeftOut  `json:"left_out"`
	Warnings    []string       `json:"warnings"`
	Limits      []string       `json:"limits"`
}

type LeakSummary struct {
	Columns        int      `json:"columns"`
	ColumnsRead    int      `json:"columns_read"`
	ColumnsWithHit int      `json:"columns_with_hits"`
	Sampled        int64    `json:"sampled"`
	Found          int64    `json:"found"`
	SampledInPart  int64    `json:"sampled_in_columns_read_in_part"`
	FoundInPart    int64    `json:"found_in_columns_read_in_part"`
	RowsRead       int64    `json:"rows_read"`
	NothingRead    bool     `json:"nothing_read"`
	Highest        Severity `json:"highest_severity"`
	DurationMillis int64    `json:"duration_ms"`
}

type Platform struct {
	Name    string   `json:"name"`
	Label   string   `json:"label"`
	Version string   `json:"version,omitempty"`
	Prefix  string   `json:"table_prefix,omitempty"`
	Details []string `json:"details,omitempty"`
}

type Relationship struct {
	ChildTable    string   `json:"child_table"`
	ChildColumns  []string `json:"child_columns"`
	ParentTable   string   `json:"parent_table"`
	ParentColumns []string `json:"parent_columns"`
	Source        string   `json:"source"`
	Status        string   `json:"status"`
	Checked       int      `json:"checked,omitempty"`
	Found         int      `json:"found,omitempty"`
	TypeColumn    string   `json:"type_column,omitempty"`
	TypeValue     string   `json:"type_value,omitempty"`
	Note          string   `json:"note,omitempty"`
}

type Result struct {
	Tool          string         `json:"tool"`
	Version       string         `json:"version"`
	GeneratedAt   time.Time      `json:"generated_at"`
	Server        ServerInfo     `json:"server"`
	Database      string         `json:"database"`
	Platforms     []Platform     `json:"platforms"`
	Options       ScanOptions    `json:"options"`
	Summary       Summary        `json:"summary"`
	Tables        []TableSummary `json:"tables"`
	Findings      []Finding      `json:"findings"`
	SideEffects   []SideEffect   `json:"side_effects"`
	Relationships []Relationship `json:"relationships"`
	Warnings      []string       `json:"warnings"`
}

type RowMask struct {
	Where string `json:"where"` // e.g. post_type IN ('shop_order', 'shop_order_refund')
	Mask  string `json:"mask"`
	Note  string `json:"note,omitempty"`
}

type ScanOptions struct {
	SampleRows     int     `json:"sample_rows"`
	MetaSampleRows int     `json:"meta_sample_rows"`
	KeySampleRows  int     `json:"key_sample_rows"`
	Samples        bool    `json:"samples"`
	Preset         string  `json:"preset"`
	TimeoutSeconds float64 `json:"statement_timeout_seconds"`
}

type Schema struct {
	Database string
	Tables   []*Table
	// contains filtered or unexported fields
}

type ServerInfo struct {
	Flavor  string `json:"flavor"`
	Version string `json:"version"`
	Address string `json:"address"`
	User    string `json:"user"`
}

type Severity int

type SideEffect struct {
	Platform string   `json:"platform"`
	Kind     string   `json:"kind"`
	Table    string   `json:"table"`
	Item     string   `json:"item,omitempty"`
	Severity Severity `json:"severity"`
	Summary  string   `json:"summary"`
	Count    int64    `json:"count,omitempty"`
	Fix      string   `json:"fix"`
}

type Summary struct {
	Tables             int            `json:"tables"`
	TablesSampled      int            `json:"tables_sampled"`
	Views              int            `json:"views"`
	RowsSampled        int64          `json:"rows_sampled"`
	TablesWithFindings int            `json:"tables_with_findings"`
	Findings           int            `json:"findings"`
	BySeverity         map[string]int `json:"by_severity"`
	ByCategory         map[string]int `json:"by_category"`
	Highest            Severity       `json:"highest_severity"`
	SideEffects        int            `json:"side_effects"`
	Relationships      int            `json:"relationships"`
	InferredConfirmed  int            `json:"inferred_relationships_confirmed"`
	DurationMillis     int64          `json:"duration_ms"`
}

type Table struct {
	Name         string
	Type         string // BASE TABLE, VIEW, SYSTEM VERSIONED, SEQUENCE
	Engine       string
	RowsEstimate int64
	DataBytes    int64
	Comment      string
	Columns      []*Column
	PrimaryKey   []string
	Indexes      []Index
	ForeignKeys  []ForeignKey
	// contains filtered or unexported fields
}

type TableSummary struct {
	Name         string   `json:"name"`
	Kind         string   `json:"kind"`
	RowsEstimate int64    `json:"rows_estimate"`
	RowsSampled  int      `json:"rows_sampled"`
	Findings     int      `json:"findings"`
	Highest      Severity `json:"highest_severity"`
	KeyColumn    string   `json:"key_column,omitempty"`
	ValueColumn  string   `json:"value_column,omitempty"`
	Keys         int      `json:"keys,omitempty"` // distinct keys read in a key/value table
	// HiddenKeys counts the keys with confident findings that reports show
	// as "(key hidden)": their names may hold data, so no rule names them.
	HiddenKeys   int    `json:"hidden_keys,omitempty"`
	Action       string `json:"suggested_action,omitempty"`
	ActionReason string `json:"action_reason,omitempty"`
	// PossibleAction is weaker than Action: a guess, such as emptying a
	// table that looks like a cache, which the user should confirm. Tools
	// that act on suggested_action never see it.
	PossibleAction       string `json:"possible_action,omitempty"`
	PossibleActionReason string `json:"possible_action_reason,omitempty"`
	Error                string `json:"error,omitempty"`
	// ReadFailed says a statement reading this key/value table's keys failed,
	// so some keys may have gone unjudged. The warnings say which statement.
	ReadFailed bool `json:"read_failed,omitempty"`
}