stats

Documentation

Index

• type Stats
  • func Init() *Stats
  • func (s *Stats) IncrementCommitsDirty()
  • func (s *Stats) IncrementCommitsScanned()
  • func (s *Stats) IncrementCommitsTotal(with int)
  • func (s *Stats) IncrementDirtyFiles()
  • func (s *Stats) IncrementFiles()
  • func (s *Stats) IncrementFilesTotal()
  • func (s *Stats) IncrementFindings()
  • func (s *Stats) IncrementFindingsTotal()
  • func (s *Stats) IncrementIgnoredFiles()
  • func (s *Stats) IncrementIgnoredFilesWith(amount int)
  • func (s *Stats) IncrementOrgs()
  • func (s *Stats) IncrementRepositories()
  • func (s *Stats) IncrementRepositoriesCloned()
  • func (s *Stats) IncrementRepositoriesScanned()
  • func (s *Stats) IncrementRepositoriesTotal()
  • func (s *Stats) IncrementScannedFiles()
  • func (s *Stats) IncrementTargets()
  • func (s *Stats) IncrementUsers()
  • func (s *Stats) UpdateStatus(to Status)
• type Status

Types

type Stats

type Stats struct {
	*sync.Mutex
	StartedAt           time.Time // The time we started the scan
	FinishedAt          time.Time // The time we finished the scan
	Status              Status    // The running status of a scan for the web interface
	Progress            float64   // The running progress for the bar on the web interface
	RepositoriesTotal   int       // The toatal number of repos discovered
	RepositoriesScanned int       // The total number of repos scanned (not excluded, errors, empty)
	RepositoriesCloned  int       // The total number of repos cloned (excludes errors and excluded, includes empty)
	Organizations       int       // The number of github orgs
	CommitsScanned      int       // The number of commits scanned in a repo
	CommitsDirty        int       // The number of commits in a repo found to have secrets
	FilesScanned        int       // The number of files actually scanned
	FilesIgnored        int       // The number of files ignored (tests, extensions, paths)
	FilesTotal          int       // The total number of files that were processed
	FilesDirty          int
	FindingsTotal       int // The total number of findings. There can be more than one finding per file and more than one finding of the same type in a file
	Users               int // Github users
	Targets             int // The number of dirs, people, orgs, etc on the command line or config file (what do you want rvsecret to enumerate on)
	Repositories        int // This will point to RepositoriesScanned
	CommitsTotal        int // This will point to commits scanned
	Findings            int // This will point to findings total
	Files               int // This will point to FilesScanned
	Commits             int // This will point to CommitsScanned
}

Stats hold various runtime statistics used for perf data as well generating various reports They are accessed from the web server as well

func Init

func Init() *Stats

InitStats will set the initial values for a session

func (*Stats) IncrementCommitsDirty

func (s *Stats) IncrementCommitsDirty()

IncrementCommitsDirty will bump the number of commits that have been found to be dirty, as in they contain one of more findings

func (*Stats) IncrementCommitsScanned

func (s *Stats) IncrementCommitsScanned()

IncrementCommitsScanned will bump the number of commits that have been scanned. This is scan wide and not on a per repo/org basis

func (*Stats) IncrementCommitsTotal

func (s *Stats) IncrementCommitsTotal(with int)

IncrementCommitsTotal will add one to the running count of commits during the target discovery phase of a session

func (*Stats) IncrementDirtyFiles

func (s *Stats) IncrementDirtyFiles()

IncrementDirtyFiles will bump the count of files that have been discovered. This does not reflect if the file was scanned/skipped. It is simply a count of files that were found.

func (*Stats) IncrementFiles

func (s *Stats) IncrementFiles()

IncrementFiles will add one to the running count of files during the target discovery phase of a session

func (*Stats) IncrementFilesTotal

func (s *Stats) IncrementFilesTotal()

IncrementFilesTotal will bump the count of files that have been discovered. This does not reflect if the file was scanned/skipped. It is simply a count of files that were found.

func (*Stats) IncrementFindings

func (s *Stats) IncrementFindings()

IncrementFindings will add one to the running count of findings during the target discovery phase of a session

func (*Stats) IncrementFindingsTotal

func (s *Stats) IncrementFindingsTotal()

IncrementFindingsTotal will bump the total number of findings that have been matched. This does exclude any other documented criteria.

func (*Stats) IncrementIgnoredFiles

func (s *Stats) IncrementIgnoredFiles()

IncrementIgnoredFiles will bump the number of files that have been ignored for various reasons.

func (*Stats) IncrementIgnoredFilesWith

func (s *Stats) IncrementIgnoredFilesWith(amount int)

IncrementIgnoredFilesWith will bump the number of files that have been ignored with a number.

func (*Stats) IncrementOrgs

func (s *Stats) IncrementOrgs()

IncrementOrgs will bump the number of orgs that have been gathered. This is scan wide and not on a per repo/org basis

func (*Stats) IncrementRepositories

func (s *Stats) IncrementRepositories()

IncrementRepositories will add one to the running repository count during the target discovery phase of a session

func (*Stats) IncrementRepositoriesCloned

func (s *Stats) IncrementRepositoriesCloned()

IncrementRepositoriesCloned will bump the number of repositories that have been cloned with errors but may be empty

func (*Stats) IncrementRepositoriesScanned

func (s *Stats) IncrementRepositoriesScanned()

IncrementRepositoriesScanned will bump the total number of repositories that have been scanned and are not empty

func (*Stats) IncrementRepositoriesTotal

func (s *Stats) IncrementRepositoriesTotal()

IncrementRepositoriesTotal will bump the total number of repositories that have been discovered. This will include empty ones as well as those that had errors

func (*Stats) IncrementScannedFiles

func (s *Stats) IncrementScannedFiles()

IncrementScannedFiles will bump the count of files that have been scanned successfully.

func (*Stats) IncrementTargets

func (s *Stats) IncrementTargets()

IncrementTargets will add one to the running target count during the target discovery phase of a session

func (*Stats) IncrementUsers

func (s *Stats) IncrementUsers()

IncrementUsers will bump the total number of users that have been enumerated

func (*Stats) UpdateStatus

func (s *Stats) UpdateStatus(to Status)

type Status

type Status string

const (
	StatusInitializing Status = "initializing"
	StatusGathering    Status = "gathering"
	StatusAnalyzing    Status = "analyzing"
	StatusFinished     Status = "finished"
)

These are various environment variables and tool statuses used in auth and displaying messages