projects

type IssueFilter struct {
	Confidence []string //high, med, low, info
	Tags       []string //test, prod
}

type Model struct {
	Grade                            string
	Logo                             string                                       `yaml:"-" json:"-"`
	SALLogo                          string                                       `yaml:"-" json:"-"`
	GradeLogo                        string                                       `yaml:"-" json:"-"`
	Chart                            string                                       `yaml:"-" json:"-"`
	CriticalCount                    int                                          `json:"criticalCount" yaml:"criticalCount"`
	HighCount                        int                                          `json:"highCount" yaml:"highCount"`
	MediumCount                      int                                          `json:"mediumCount" yaml:"mediumCount"`
	LowCount                         int                                          `json:"lowCount" yaml:"lowCount"`
	InformationalCount               int                                          `json:"informationalCount" yaml:"informationalCount"`
	ProductionConfidentialFilesCount int                                          `json:"productionConfidentialFilesCount" yaml:"productionConfidentialFilesCount"`
	FileCount                        int                                          `json:"fileCount" yaml:"fileCount"`
	SkippedCount                     int                                          `json:"skippedCount" yaml:"skippedCount"`
	IssuesPerType                    int                                          `json:"issuesPerType" yaml:"issuesPerType"`
	AveragePerFile                   float32                                      `json:"averagePerFile" yaml:"averagePerFile"`
	Issues                           []*diagnostics.SecurityDiagnostic            `yaml:"-" json:"-"`
	TimeStamp                        string                                       `json:"timeStamp" yaml:"timeStamp"`
	ShowSource                       bool                                         `json:"showSource" yaml:"showSource"`
	ReusedSecretsCount               int                                          `json:"reusedSecretsCount" yaml:"reusedSecretsCount"`
	NumberOfSecretsReuse             int                                          `json:"numberOfSecretsReuse" yaml:"numberOfSecretsReuse"`
	ReusedSecrets                    map[string][]*diagnostics.SecurityDiagnostic `yaml:"-" json:"-"`
	ProdAndNonProdSecretReuse        []ReusedSecret                               `json:"prodAndNonProdSecretReuse" yaml:"prodAndNonProdSecretReuse"`
	ProductionSecretsCount           int                                          `json:"prodSecretsCount" yaml:"prodSecretsCount"`
	CriticalProdUsedInNonProdCount   int                                          `yaml:"criticalProdUsedInNonProdCount" json:"criticalProdUsedInNonProdCount"`
	HighProdUsedInNonProdCount       int                                          `yaml:"highProdUsedInNonProdCount" json:"highProdUsedInNonProdCount"`
	MediumProdUsedInNonProdCount     int                                          `yaml:"mediumProdUsedInNonProdCount" json:"mediumProdUsedInNonProdCount"`
	LowProdUsedInNonProdCount        int                                          `yaml:"lowProdUsedInNonProdCount" json:"lowProdUsedInNonProdCount"`
	InfoProdUsedInNonProdCount       int                                          `yaml:"infoProdUsedInNonProdCount" json:"infoProdUsedInNonProdCount"`
	CriticalSensitiveFileCount       int                                          `yaml:"criticalSensitiveFileCount" json:"criticalSensitiveFileCount"`
	HighSensitiveFileCount           int                                          `yaml:"highSensitiveFileCount" json:"highSensitiveFileCount"`
	MediumSensitiveFileCount         int                                          `yaml:"mediumSensitiveFileCount" json:"mediumSensitiveFileCount"`
	LowSensitiveFileCount            int                                          `yaml:"lowSensitiveFileCount" json:"lowSensitiveFileCount"`
	InfoSensitiveFileCount           int                                          `yaml:"infoSensitiveFileCount" json:"infoSensitiveFileCount"`
	NonProdSensitiveFileCount        int                                          `yaml:"nonProdSensitiveFileCount" json:"nonProdSensitiveFileCount"`
	SecretReuseCountBuckets          []int                                        `yaml:"secretReuseCountBuckets" json:"secretReuseCountBuckets"`
}

type ModelCounts struct {
	CriticalCount                    int     `json:"criticalCount" yaml:"criticalCount"`
	HighCount                        int     `json:"highCount" yaml:"highCount"`
	MediumCount                      int     `json:"mediumCount" yaml:"mediumCount"`
	LowCount                         int     `json:"lowCount" yaml:"lowCount"`
	InformationalCount               int     `json:"informationalCount" yaml:"informationalCount"`
	ProductionConfidentialFilesCount int     `json:"productionConfidentialFilesCount" yaml:"productionConfidentialFilesCount"`
	FileCount                        int     `json:"fileCount" yaml:"fileCount"`
	SkippedCount                     int     `json:"skippedCount" yaml:"skippedCount"`
	IssuesPerType                    int     `json:"issuesPerType" yaml:"issuesPerType"`
	AveragePerFile                   float32 `json:"averagePerFile" yaml:"averagePerFile"`
	ReusedSecretsCount               int     `json:"reusedSecretsCount" yaml:"reusedSecretsCount"`
	NumberOfSecretsReuse             int     `json:"numberOfSecretsReuse" yaml:"numberOfSecretsReuse"`
	CriticalProdUsedInNonProdCount   int     `yaml:"criticalProdUsedInNonProdCount" json:"criticalProdUsedInNonProdCount"`
	HighProdUsedInNonProdCount       int     `yaml:"highProdUsedInNonProdCount" json:"highProdUsedInNonProdCount"`
	MediumProdUsedInNonProdCount     int     `yaml:"mediumProdUsedInNonProdCount" json:"mediumProdUsedInNonProdCount"`
	LowProdUsedInNonProdCount        int     `yaml:"lowProdUsedInNonProdCount" json:"lowProdUsedInNonProdCount"`
	InfoProdUsedInNonProdCount       int     `yaml:"infoProdUsedInNonProdCount" json:"infoProdUsedInNonProdCount"`
	CriticalSensitiveFileCount       int     `yaml:"criticalSensitiveFileCount" json:"criticalSensitiveFileCount"`
	HighSensitiveFileCount           int     `yaml:"highSensitiveFileCount" json:"highSensitiveFileCount"`
	MediumSensitiveFileCount         int     `yaml:"mediumSensitiveFileCount" json:"mediumSensitiveFileCount"`
	LowSensitiveFileCount            int     `yaml:"lowSensitiveFileCount" json:"lowSensitiveFileCount"`
	InfoSensitiveFileCount           int     `yaml:"infoSensitiveFileCount" json:"infoSensitiveFileCount"`
	ProductionSecretsCount           int     `json:"prodSecretsCount" yaml:"prodSecretsCount"`
	NonProdSensitiveFileCount        int     `yaml:"nonProdSensitiveFileCount" json:"nonProdSensitiveFileCount"`
	SecretReuseCountBuckets          []int   `yaml:"secretReuseCountBuckets" json:"secretReuseCountBuckets"`
}

type PagedResult struct {
	Total       int
	Page        int
	Diagnostics []*diagnostics.SecurityDiagnostic
}

type PaginatedIssueSearch struct {
	ProjectID string
	ScanID    string
	PageSize  int
	Page      int
	Filter    IssueFilter
}

type Project struct {
	ID                   string       `yaml:"ID"`                   //unique
	Name                 string       `yaml:"Name"`                 //human-friendly
	Workspace            string       `yaml:"Workspace"`            //Used to group related projects
	DeleteCheckedOutCode bool         `yaml:"DeleteCheckedOutCode"` //whether to delete code checked out after scan is complete
	Repositories         []Repository `yaml:"Repositories,omitempty"`
	ScanIDs              []string     `yaml:"ScanIDs"`
	ScanPolicy           ScanPolicy   `yaml:"ScanPolicy"`
}

type ProjectDescription struct {
	Name         string       `yaml:"Name"` //human-friendly
	Repositories []Repository `yaml:"Repositories,omitempty"`
	Workspace    string       `yaml:"Workspace"` //Used to group related projects
	ScanPolicy   ScanPolicy   `yaml:"ScanPolicy"`
}

type ProjectDescriptionWire struct {
	Name         string         `yaml:"Name"` //human-friendly
	Repositories []Repository   `yaml:"Repositories,omitempty"`
	Workspace    string         `yaml:"Workspace"` //Used to group related projects
	ScanPolicy   ScanPolicyWire `yaml:"ScanPolicy"`
}

type ProjectManager interface {
	GetWorkspaces() (*Workspace, error)
	SaveWorkspaces(*Workspace) error
	SaveProjectSummary(*ProjectSummary) error
	ListProjectSummaries() []*ProjectSummary
	GetProjectSummary(projectID string) (*ProjectSummary, error)
	GetProject(id string) (Project, error)
	DeleteProject(id string) error
	GetScanConfig(projectID, scanID string) (*ScanPolicy, error)
	GetScanResults(projectID, scanID string) ([]*diagnostics.SecurityDiagnostic, error)
	GetScanResultSummary(projectID, scanID string) (ScanSummary, error)
	// SummariseScanResults(projectID, scanID string, summariser func(projectID, scanID string, issues []*diagnostics.SecurityDiagnostic) *ScanSummary) error
	RunScan(ctx context.Context, projectID string, scanPolicy ScanPolicy, scanner SecurityScanner,
		scanIDCallback func(string), progressMonitor func(diagnostics.Progress),
		summariser ScanSummariser, wsSummariser WorkspaceSummariser,
		consumers ...diagnostics.SecurityDiagnosticsConsumer)

	CreateProject(projectDescription ProjectDescription) (*Project, error)
	UpdateProject(projectID string, projectDescription ProjectDescription,
		wsSummariser WorkspaceSummariser) (*Project, error)
	GetIssues(paginated PaginatedIssueSearch) (*PagedResult, error)
	RemediateIssue(exclude diagnostics.ExcludeRequirement) diagnostics.PolicyUpdateResult
	GetCodeContext(cnt common.CodeContext) string
	GetProjectLocation(projID string) string
	GetGitConfigManager() (gitutils.GitConfigManager, error)
	// GetScanLocation(projID, scanID string) string
	//CheckMate base directory
	GetBaseDir() string
	//Base directory for code checkout
	GetCodeBaseDir() string
	//Release resources if necessary
	Close() error
}

type ProjectSummary struct {
	ID           string       `yaml:"ID" json:"ID"`
	Name         string       `yaml:"Name" json:"Name"`
	Workspace    string       `yaml:"Workspace" json:"Workspace"` //Used to group related projects
	Repositories []Repository `yaml:"Repositories,omitempty" json:"Repositories,omitempty"`
	//From RepoLocation -> branch -> RepoHistory
	ScanAndCommitHistories map[string]map[string]RepositoryHistory `yaml:"ScanAndCommitHistories,omitempty" json:"ScanAndCommitHistories,omitempty"`
	LastScanID             string                                  `yaml:"LastScanID" json:"LastScanID"`
	ScanIDs                []string                                `yaml:"ScanIDs" json:"ScanIDs"`
	ScanPolicy             ScanPolicy                              `yaml:"ScanPolicy" json:"ScanPolicy"`
	ScoreTrend             map[string]float32                      `yaml:"ScoreTrend,omitempty" json:"ScoreTrend,omitempty"` // use this to record arbitrary numeric scores, even time series of trends etc.
	LastScanSummary        ScanSummary                             `yaml:"LastScanSummary" json:"LastScanSummary"`
	LastScore              Score                                   `yaml:"LastScore" json:"LastScore"`
	IsBeingScanned         bool                                    `yaml:"IsBeingScanned" json:"IsBeingScanned"`
	CreationDate           time.Time                               `yaml:"CreationDate" json:"CreationDate"`
	LastModification       time.Time                               `yaml:"LastModification" json:"LastModification"`
	LastScan               time.Time                               `yaml:"LastScan" json:"LastScan"`
}

type ProjectSummarySlice []*ProjectSummary

type Repository struct {
	Location     string `yaml:"Location"`
	LocationType string `yaml:"LocationType"` //filesystem, git, svn etc.
	GitServiceID string `yaml:"GitServiceID"` /*if this repository is from a "private" on-prem instance,
	the service ID is used to locate the instance and associated API keys etc*/
	Monitor bool `yaml:"Monitor"` //If this repository is continuously monitored for changes
}

type RepositoryHistory struct {
	Repository      Repository
	ScanHistories   []ScanHistory
	CommitHistories []gitutils.Commit
}

type ReusedSecret struct {
	Secret                 string
	ProductionLocations    []SecretLocation `json:"productionLocations"`
	NonProductionLocations []SecretLocation `json:"nonProductionLocations"`
}

type Scan struct {
	ID         string
	Score      Score
	Start, End time.Time
	Issues     []diagnostics.SecurityDiagnostic
	Policy     ScanPolicy
}

type ScanHistory struct {
	Time   time.Time
	ScanID string
	Commit gitutils.Commit
}

type ScanPolicy struct {
	ID           string                        `yaml:"ID"`
	Policy       diagnostics.ExcludeDefinition `yaml:"Policy,omitempty"`
	PolicyString string                        `yaml:"-"`
	Config       map[string]interface{}        //indexes to scan configurations, use the key "secrets" for secret finder
}

type ScanPolicyWire struct {
	ID           string `yaml:"ID"`
	Policy       string `yaml:"Policy,omitempty"`
	PolicyString string
	Config       map[string]interface{} //indexes to scan configurations, key secrets for secret finder
}

type ScanSummariser func(projectID, scanID string, issues []*diagnostics.SecurityDiagnostic) *ScanSummary

type ScanSummary struct {
	Score          Score
	CommitHash     string
	AdditionalInfo *Model
}

type ScannedCommit struct {
	Repository string
	Commit     gitutils.Commit
}

type Score struct {
	Grade      string             // A+ -> F
	Metric     float32            //100% -> 0%
	TimeStamp  time.Time          //when the scan was completed
	SubMetrics map[string]float32 // use this to record arbitrary numeric scores, even time series of trends etc.
}

type SecretLocation struct {
	Location       string
	HighlightRange code.Range `json:"highLightRange"`
}

type SecurityScanner interface {
	//runs a scan over a project, with a specific scanID, project manager provides infrastructure for interrogating
	//the project such as code repositories or locations, a prorgress callback provides indication of how the scan is progressing
	//and consumers receive the results of scan
	Scan(ctx context.Context, projectID string, scanID string, pm ProjectManager,
		callback func(diagnostics.Progress), consumers ...diagnostics.SecurityDiagnosticsConsumer)
}

type Workspace struct {
	Details map[string]*WorkspaceDetail `json:"Details" yaml:"Details"`
}

type WorkspaceDetail struct {
	Summary          *ScanSummary      `json:"Summary" yaml:"Summary"`
	ProjectSummaries []*ProjectSummary `json:"ProjectSummaries" yaml:"ProjectSummaries"`
}

type WorkspaceSummariser func(pm ProjectManager, workspacesToUpdate []string) (*Workspace, error)