session

Documentation

Index

• Constants
• func ValidateNewSession(session *Session) error
• type Session
  • func (s *Session) AddFinding(finding *findings.Finding)
  • func (s *Session) AddRepository(repository *gitprovider.Repository)
  • func (s *Session) End()
  • func (s *Session) InitLogger()
  • func (s *Session) InitStateStoreOrFail(filepath string)
  • func (s *Session) InitStats()
  • func (s *Session) InitThreads()
  • func (s *Session) Initialize(options options.Options)
  • func (s *Session) SaveToFile(location string) (string, error)

Constants

const (
	// StatusInitializing ...
	StatusInitializing = "initializing"

	// StatusGathering ...
	StatusGathering = "gathering"

	// StatusAnalyzing ...
	StatusAnalyzing = "analyzing"

	// StatusFinished ...
	StatusFinished = "finished"

	// ContentScan ...
	ContentScan = "Content Scan"

	// PathScan ...
	PathScan = "Path Scan"
)

Functions

func ValidateNewSession

func ValidateNewSession(session *Session) error

ValidateNewSession validates new session

Types

type Session

type Session struct {
	sync.Mutex

	Options      options.Options `json:"-"`
	Out          *log.Logger     `json:"-"`
	Stats        *stats.Stats
	Findings     []*findings.Finding
	Repositories []*gitprovider.Repository
	Signatures   []signatures.Signature `json:"-"`
	StateStore   *state.JSONFileStore
}

Session contains fields describing a scan session

func (*Session) AddFinding

func (s *Session) AddFinding(finding *findings.Finding)

AddFinding adds a finding

func (*Session) AddRepository

func (s *Session) AddRepository(repository *gitprovider.Repository)

AddRepository adds a repo

func (*Session) End

func (s *Session) End()

End end a scan session

func (*Session) InitLogger

func (s *Session) InitLogger()

InitLogger inits a logger

func (*Session) InitStateStoreOrFail

func (s *Session) InitStateStoreOrFail(filepath string)

InitStateStoreOrFail inits a history storage

func (*Session) InitStats

func (s *Session) InitStats()

InitStats inits stats

func (*Session) InitThreads

func (s *Session) InitThreads()

InitThreads inits threads

func (*Session) Initialize

func (s *Session) Initialize(options options.Options)

Initialize inits a scan session

func (*Session) SaveToFile

func (s *Session) SaveToFile(location string) (string, error)

SaveToFile exports scan results to file