codeql

Documentation

Index

• Constants
• func AppendCustomFlags(cmd []string, flags map[string]string) []string
• func AppendFlagIfNotSetByUser(cmd []string, flagToCheck []string, flagToAppend []string, ...) []string
• func AppendThreadsAndRam(cmd []string, threads, ram string, customFlags map[string]string) []string
• func CreateAndPersistToolRecord(utils piperutils.FileUtils, repoInfo *RepoInfo, modulePath string) (string, error)
• func IsFlagSetByUser(customFlags map[string]string, flagsToCheck []string) bool
• func ParseCustomFlags(flagsStr string) map[string]string
• func WaitSarifUploaded(maxRetries, checkRetryInterval int, codeqlSarifUploader CodeqlSarifUploader) error
• func WriteJSONReport(jsonReport CodeqlAudit, modulePath string) ([]piperutils.Path, error)
• type CodeqlAudit
• type CodeqlFindings
• type CodeqlSarifUploader
• type CodeqlSarifUploaderInstance
  • func NewCodeqlSarifUploaderInstance(url, token string) CodeqlSarifUploaderInstance
  • func (codeqlSarifUploader *CodeqlSarifUploaderInstance) GetSarifStatus() (SarifFileInfo, error)
• type CodeqlScanAudit
• type CodeqlScanAuditInstance
  • func NewCodeqlScanAuditInstance(serverUrl, owner, repository, token string, trustedCerts []string) CodeqlScanAuditInstance
  • func (codeqlScanAudit *CodeqlScanAuditInstance) GetVulnerabilities(analyzedRef string) ([]CodeqlFindings, error)
• type GitUploader
• type GitUploaderInstance
  • func NewGitUploaderInstance(token, ref, dbDir, sourceCommitId, sourceRepo, targetRepo string) (*GitUploaderInstance, error)
  • func (uploader *GitUploaderInstance) UploadProjectToGithub() (string, error)
• type RepoInfo
  • func GetRepoInfo(...) (*RepoInfo, error)
• type SarifFileInfo

Constants

const (
	CommitMessageMirroringCode = "Mirroring code for revision %s from %s"
	SrcZip                     = "src.zip"
	CodeqlDatabaseYml          = "codeql-database.yml"
	OriginRemote               = "origin"
)

const AuditAll string = "Audit All"

const Optional string = "Optional"

Functions

func AppendCustomFlags

func AppendCustomFlags(cmd []string, flags map[string]string) []string

func AppendFlagIfNotSetByUser

func AppendFlagIfNotSetByUser(cmd []string, flagToCheck []string, flagToAppend []string, customFlags map[string]string) []string

func AppendThreadsAndRam

func AppendThreadsAndRam(cmd []string, threads, ram string, customFlags map[string]string) []string

func CreateAndPersistToolRecord

func CreateAndPersistToolRecord(utils piperutils.FileUtils, repoInfo *RepoInfo, modulePath string) (string, error)

func IsFlagSetByUser

func IsFlagSetByUser(customFlags map[string]string, flagsToCheck []string) bool

func ParseCustomFlags

func ParseCustomFlags(flagsStr string) map[string]string

func WaitSarifUploaded

func WaitSarifUploaded(maxRetries, checkRetryInterval int, codeqlSarifUploader CodeqlSarifUploader) error

func WriteJSONReport

func WriteJSONReport(jsonReport CodeqlAudit, modulePath string) ([]piperutils.Path, error)

Types

type CodeqlAudit

type CodeqlAudit struct {
	ToolName               string           `json:"toolName"`
	RepositoryUrl          string           `json:"repositoryUrl"`
	RepositoryReferenceUrl string           `json:"repositoryReferenceUrl"` //URL of PR or Branch where scan was performed
	CodeScanningLink       string           `json:"codeScanningLink"`
	QuerySuite             string           `json:"querySuite"`
	ScanResults            []CodeqlFindings `json:"findings"`
}

type CodeqlFindings

type CodeqlFindings struct {
	ClassificationName string `json:"classificationName"`
	Total              int    `json:"total"`
	Audited            int    `json:"audited"`
}

type CodeqlSarifUploader

type CodeqlSarifUploader interface {
	GetSarifStatus() (SarifFileInfo, error)
}

type CodeqlSarifUploaderInstance

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

func NewCodeqlSarifUploaderInstance

func NewCodeqlSarifUploaderInstance(url, token string) CodeqlSarifUploaderInstance

func (*CodeqlSarifUploaderInstance) GetSarifStatus

func (codeqlSarifUploader *CodeqlSarifUploaderInstance) GetSarifStatus() (SarifFileInfo, error)

type CodeqlScanAudit

type CodeqlScanAudit interface {
	GetVulnerabilities(analyzedRef string, state string) error
}

type CodeqlScanAuditInstance

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

func NewCodeqlScanAuditInstance

func NewCodeqlScanAuditInstance(serverUrl, owner, repository, token string, trustedCerts []string) CodeqlScanAuditInstance

func (*CodeqlScanAuditInstance) GetVulnerabilities

func (codeqlScanAudit *CodeqlScanAuditInstance) GetVulnerabilities(analyzedRef string) ([]CodeqlFindings, error)

type GitUploader

type GitUploader interface {
	UploadProjectToGithub() (string, error)
}

type GitUploaderInstance

type GitUploaderInstance struct {
	*command.Command
	// contains filtered or unexported fields
}

func NewGitUploaderInstance

func NewGitUploaderInstance(token, ref, dbDir, sourceCommitId, sourceRepo, targetRepo string) (*GitUploaderInstance, error)

func (*GitUploaderInstance) UploadProjectToGithub

func (uploader *GitUploaderInstance) UploadProjectToGithub() (string, error)

type RepoInfo

type RepoInfo struct {
	ServerUrl   string
	Owner       string
	Repo        string
	CommitId    string
	AnalyzedRef string
	FullRef     string
	FullUrl     string
	ScanUrl     string
}

func GetRepoInfo

func GetRepoInfo(repository, analyzedRef, commitID, targetGithubRepoURL, targetGithubBranchName string) (*RepoInfo, error)

type SarifFileInfo

type SarifFileInfo struct {
	ProcessingStatus string   `json:"processing_status"`
	Errors           []string `json:"errors"`
}