models

type Credential struct {
	ID     uint `json:"id" gorm:"primarykey"`
	FileID uint `json:"file_id" gorm:"index:idx_cred"`

	Rule string    `json:"rule"`
	Time time.Time `json:"time"`

	UserDomain string `json:"user_domain"`
	Username   string `json:"username"`
	Password   string `json:"password"`

	CPF string `json:"cpf"`

	Url       string `json:"url"`
	UrlDomain string `json:"url_domain"`

	Severity int     `json:"severity"`
	Entropy  float32 `json:"entropy"`

	NearText string `json:"near_text"`
}

type Document struct {
	ID     uint `json:"id" gorm:"primarykey"`
	FileID uint `json:"file_id" gorm:"index:idx_document"`

	Time time.Time `json:"time"`

	Raw    string `json:"raw"`
	Number string `json:"number"`
	IsCPF  bool   `json:"is_cpf"`
	IsCNPJ bool   `json:"is_cnpj"`

	Source   string `json:"source"`
	FileName string `json:"file_name"`
	Line     string `json:"line"`

	NearText string `json:"near_text"`
}

type Email struct {
	ID     uint `json:"id" gorm:"primarykey"`
	FileID uint `json:"file_id" gorm:"index:idx_email"`

	Time time.Time `json:"time"`

	Domain string `json:"domain"`
	Email  string `json:"email"`

	NearText string `json:"near_text"`
}

type File struct {
	ID uint `json:"id" gorm:"primarykey"`

	Provider  string    `json:"provider"` //IntelX, ...
	FilePath  string    `json:"file_path"`
	FileName  string    `json:"file_name"`
	Name      string    `json:"name"`
	Date      time.Time `json:"date"`
	Bucket    string    `json:"bucket"`
	MediaType string    `json:"media_type"`
	IndexedAt time.Time `json:"indexed_at"`

	Size        uint   `json:"size"`
	ProviderId  string `json:"provider_id"`
	MIMEType    string `json:"mime_type"`
	Fingerprint string `json:"fingerprint";gorm:"unique;not null"`

	Content string `json:"content"`

	// Failed flag set if the result should be considered failed
	Failed       bool   `json:"failed"`
	FailedReason string `json:"failed_reason"`

	Credentials []Credential `json:"credentials" gorm:"constraint:OnDelete:CASCADE"`
	Emails      []Email      `json:"emails" gorm:"constraint:OnDelete:CASCADE"`
	URLs        []URL        `json:"urls" gorm:"constraint:OnDelete:CASCADE"`
	Phones      []Phone      `json:"phones" gorm:"constraint:OnDelete:CASCADE"`
	Documents   []Document   `json:"documents" gorm:"constraint:OnDelete:CASCADE"`
}

type Finding struct {
	// Rule is the name of the rule that was matched
	RuleID      string
	Description string

	StartLine   int
	EndLine     int
	StartColumn int
	EndColumn   int

	Line string `json:"-"`

	Match string

	// Secret contains the full content of what is matched in
	// the tree-sitter query.
	Secret string

	// File is the name of the file containing the finding
	File        string
	SymlinkFile string
	Commit      string
	Link        string `json:",omitempty"`

	// Entropy is the shannon entropy of Value
	Entropy float32

	Author  string
	Date    string
	Message string
	Tags    []string

	// unique identifier
	Fingerprint string

	Credential Credential
	Email      Email
	Url        URL
	Phone      Phone
	Document   Document
}

type Phone struct {
	ID     uint `json:"id" gorm:"primarykey"`
	FileID uint `json:"file_id" gorm:"index:idx_phone"`

	Time time.Time `json:"time"`

	Country string `json:"country"`
	Raw     string `json:"raw"`
	Phone   string `json:"phone"`

	Source   string `json:"source"`
	FileName string `json:"file_name"`
	Line     string `json:"line"`

	NearText string `json:"near_text"`
}

type URL struct {
	ID     uint `json:"id" gorm:"primarykey"`
	FileID uint `json:"file_id" gorm:"index:idx_url"`

	Time time.Time `json:"time"`

	Domain string `json:"domain"`
	Url    string `json:"url"`

	NearText string `json:"near_text"`
}