The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- Variables
- func AutomaticDependencyUpdate(c *checker.CheckRequest) checker.CheckResult
- func BinaryArtifacts(c *checker.CheckRequest) checker.CheckResult
- func BranchProtection(c *checker.CheckRequest) checker.CheckResult
- func CIIBestPractices(c *checker.CheckRequest) checker.CheckResult
- func CITests(c *checker.CheckRequest) checker.CheckResult
- func CheckFilesContent(shellPathFnPattern string, caseSensitive bool, c *checker.CheckRequest, ...) (bool, error)
- func CheckIfFileExists(checkName string, c *checker.CheckRequest, ...) (bool, error)
- func CodeQLInCheckDefinitions(c *checker.CheckRequest) (int, string, error)
- func Contributors(c *checker.CheckRequest) checker.CheckResult
- func DoesCodeReview(c *checker.CheckRequest) checker.CheckResult
- func FrozenDeps(c *checker.CheckRequest) checker.CheckResult
- func Fuzzing(c *checker.CheckRequest) checker.CheckResult
- func HasUnfixedVulnerabilities(c *checker.CheckRequest) checker.CheckResult
- func IsActive(c *checker.CheckRequest) checker.CheckResult
- func IsBranchProtected(protection *github.Protection, branch string, dl checker.DetailLogger) checker.CheckResult
- func Packaging(c *checker.CheckRequest) checker.CheckResult
- func PullRequests(c *checker.CheckRequest) checker.CheckResult
- func SAST(c *checker.CheckRequest) checker.CheckResult
- func SASTToolInCheckRuns(c *checker.CheckRequest) (int, string, error)
- func SecurityPolicy(c *checker.CheckRequest) checker.CheckResult
- func SignedReleases(c *checker.CheckRequest) checker.CheckResult
- func SignedTags(c *checker.CheckRequest) checker.CheckResult
Constants ¶
const (
CheckActive = "Active"
)
const CheckAutomaticDependencyUpdate = "Automatic-Dependency-Update"
const CheckBinaryArtifacts string = "Binary-Artifacts"
const (
CheckBranchProtection = "Branch-Protection"
)
const CheckCIIBestPractices = "CII-Best-Practices"
CheckCIIBestPractices is the registered name for CIIBestPractices.
const (
// CheckCITests is the registered name for CITests.
CheckCITests = "CI-Tests"
)
const CheckCodeReview = "Code-Review"
CheckCodeReview is the registered name for DoesCodeReview.
const (
// CheckContributors is the registered name for Contributors.
CheckContributors = "Contributors"
)
const CheckFrozenDeps = "Frozen-Deps"
CheckFrozenDeps is the registered name for FrozenDeps.
const CheckFuzzing = "Fuzzing"
CheckFuzzing is the registered name for Fuzzing.
const CheckPackaging = "Packaging"
CheckPackaging is the registered name for Packaging.
const CheckPermissions = "Token-Permissions"
const CheckPullRequests = "Pull-Requests"
CheckPullRequests is the registered name for PullRequests.
const CheckSAST = "SAST"
CheckSAST is the registered name for SAST.
const CheckSecurityPolicy = "Security-Policy"
CheckSecurityPolicy is the registred name for SecurityPolicy.
const (
// CheckSignedReleases is the registered name for SignedReleases.
CheckSignedReleases = "Signed-Releases"
)
const (
// CheckSignedTags is the registered name for SignedTags.
CheckSignedTags = "Signed-Tags"
)
const (
// CheckVulnerabilities is the registered name for the OSV check.
CheckVulnerabilities = "Vulnerabilities"
)
Variables ¶
var AllChecks = checker.CheckNameToFnMap{}
AllChecks is the list of all security checks that will be run.
Functions ¶
func AutomaticDependencyUpdate ¶
func AutomaticDependencyUpdate(c *checker.CheckRequest) checker.CheckResult
AutomaticDependencyUpdate will check the repository if it contains Automatic dependency update.
func BinaryArtifacts ¶
func BinaryArtifacts(c *checker.CheckRequest) checker.CheckResult
BinaryArtifacts will check the repository if it contains binary artifacts.
func BranchProtection ¶
func BranchProtection(c *checker.CheckRequest) checker.CheckResult
func CIIBestPractices ¶
func CIIBestPractices(c *checker.CheckRequest) checker.CheckResult
func CITests ¶
func CITests(c *checker.CheckRequest) checker.CheckResult
func CheckFilesContent ¶
func CheckFilesContent(shellPathFnPattern string, caseSensitive bool, c *checker.CheckRequest, onFileContent func(path string, content []byte, dl checker.DetailLogger) (bool, error), ) (bool, error)
CheckFilesContent downloads the tar of the repository and calls the onFileContent() function shellPathFnPattern is used for https://golang.org/pkg/path/#Match Warning: the pattern is used to match (1) the entire path AND (2) the filename alone. This means:
- To scope the search to a directory, use "./dirname/*". Example, for the root directory, use "./*".
- A pattern such as "*mypatern*" will match files containing mypattern in *any* directory.
nolint
func CheckIfFileExists ¶
func CheckIfFileExists(checkName string, c *checker.CheckRequest, onFile func(name string, dl checker.DetailLogger) (bool, error)) (bool, error)
CheckIfFileExists downloads the tar of the repository and calls the onFile() to check for the occurrence.
func CodeQLInCheckDefinitions ¶
func CodeQLInCheckDefinitions(c *checker.CheckRequest) (int, string, error)
nolint
func Contributors ¶
func Contributors(c *checker.CheckRequest) checker.CheckResult
func DoesCodeReview ¶
func DoesCodeReview(c *checker.CheckRequest) checker.CheckResult
DoesCodeReview attempts to determine whether a project requires review before code gets merged. It uses a set of heuristics: - Looking at the repo configuration to see if reviews are required. - Checking if most of the recent merged PRs were "Approved". - Looking for other well-known review labels.
func FrozenDeps ¶
func FrozenDeps(c *checker.CheckRequest) checker.CheckResult
FrozenDeps will check the repository if it contains frozen dependecies.
func Fuzzing ¶
func Fuzzing(c *checker.CheckRequest) checker.CheckResult
func HasUnfixedVulnerabilities ¶
func HasUnfixedVulnerabilities(c *checker.CheckRequest) checker.CheckResult
func IsActive ¶
func IsActive(c *checker.CheckRequest) checker.CheckResult
func IsBranchProtected ¶
func IsBranchProtected(protection *github.Protection, branch string, dl checker.DetailLogger) checker.CheckResult
func Packaging ¶
func Packaging(c *checker.CheckRequest) checker.CheckResult
func PullRequests ¶
func PullRequests(c *checker.CheckRequest) checker.CheckResult
func SAST ¶
func SAST(c *checker.CheckRequest) checker.CheckResult
func SASTToolInCheckRuns ¶
func SASTToolInCheckRuns(c *checker.CheckRequest) (int, string, error)
nolint
func SecurityPolicy ¶
func SecurityPolicy(c *checker.CheckRequest) checker.CheckResult
func SignedReleases ¶
func SignedReleases(c *checker.CheckRequest) checker.CheckResult
func SignedTags ¶
func SignedTags(c *checker.CheckRequest) checker.CheckResult
Types ¶
This section is empty.
Source Files
¶
- active.go
- all_checks.go
- automatic_dependency_update.go
- binary_artifact.go
- branch_protected.go
- checkforcontent.go
- checkforfile.go
- ci_tests.go
- cii_best_practices.go
- code_review.go
- contributors.go
- errors.go
- frozen_deps.go
- fuzzing.go
- packaging.go
- permissions.go
- pull_requests.go
- sast.go
- security_policy.go
- shell_download_validate.go
- signed_releases.go
- signed_tags.go
- vulnerabilities.go
Directories