models

type Exception struct {
	Name string

	// Regular expresion that should match the name of the rule.
	Rule *regexp.Regexp

	// Regular expresion that should match the name of the object.
	Object *regexp.Regexp

	// Number of line where the secret is found in the contect of the object.
	Nline *int

	// Regular expresion that should match the content of the object.
	Content *regexp.Regexp
}

type KeyHash *[]byte

type MetadataAttributes struct {
	// All objects with same value on this key has the same content. It's used
	// to optimise the inspection.
	PrimaryKey bool
}

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

type Object struct {
	Type    string
	SubType string

	Name    string
	Content []byte

	Metadata       map[string]MetadataData
	PrimaryKeyHash KeyHash
}

type Rule struct {
	// Contains the name of the rule.
	Name string

	// Specifies if the rule is enabled or not.
	Enabled bool

	// All lines of the content are analised separatelly.
	// For a line to be considered a secret it should match the Match regular
	// expression and not match any of the regular expressions contained on the
	// Unmacth array.
	Match   *regexp.Regexp
	Unmatch []*regexp.Regexp
}

type RunResult struct {
	Line  string
	Nline int
}

type Secret struct {
	// Object in witch the secret is found.
	Object *Object

	// Rule that matches.
	Rule *Rule

	// Number of line in the content that contains the secret.
	Nline int

	// Content of the specific line.
	Line string

	// Specifies if this matches an exception too.
	Exception bool
}