checks

Documentation

Overview

Package checks defines all Scorecard checks.

Index

• Constants
• 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 CodeReview(c *checker.CheckRequest) checker.CheckResult
• func Contributors(c *checker.CheckRequest) checker.CheckResult
• func DangerousWorkflow(c *checker.CheckRequest) checker.CheckResult
• func DependencyUpdateTool(c *checker.CheckRequest) checker.CheckResult
• func Fuzzing(c *checker.CheckRequest) checker.CheckResult
• func GetAll() checker.CheckNameToFnMap
• func GetAllWithExperimental() checker.CheckNameToFnMap
• func License(c *checker.CheckRequest) checker.CheckResult
• func Maintained(c *checker.CheckRequest) checker.CheckResult
• func Packaging(c *checker.CheckRequest) checker.CheckResult
• func PinningDependencies(c *checker.CheckRequest) checker.CheckResult
• func SAST(c *checker.CheckRequest) checker.CheckResult
• func SecurityPolicy(c *checker.CheckRequest) checker.CheckResult
• func SignedReleases(c *checker.CheckRequest) checker.CheckResult
• func TokenPermissions(c *checker.CheckRequest) checker.CheckResult
• func Vulnerabilities(c *checker.CheckRequest) checker.CheckResult
• func WebHooks(c *checker.CheckRequest) checker.CheckResult

Constants

const CheckBinaryArtifacts string = "Binary-Artifacts"

CheckBinaryArtifacts is the exported name for Binary-Artifacts check.

const CheckBranchProtection = "Branch-Protection"

CheckBranchProtection is the exported name for Branch-Protected check.

const CheckCIIBestPractices = "CII-Best-Practices"

CheckCIIBestPractices is the registered name for CIIBestPractices.

const CheckCITests = "CI-Tests"

const CheckCodeReview = "Code-Review"

CheckCodeReview is the registered name for DoesCodeReview.

const CheckContributors = "Contributors"

CheckContributors is the registered name for Contributors.

const CheckDangerousWorkflow = "Dangerous-Workflow"

CheckDangerousWorkflow is the exported name for Dangerous-Workflow check.

const CheckDependencyUpdateTool = "Dependency-Update-Tool"

CheckDependencyUpdateTool is the exported name for Dependency-Update-Tool.

const CheckFuzzing = "Fuzzing"

CheckFuzzing is the registered name for Fuzzing.

const CheckLicense = "License"

CheckLicense is the registered name for License.

const CheckMaintained = "Maintained"

CheckMaintained is the exported check name for Maintained.

const CheckPackaging = "Packaging"

CheckPackaging is the registered name for Packaging.

const CheckPinnedDependencies = "Pinned-Dependencies"

CheckPinnedDependencies is the registered name for FrozenDeps.

const CheckSAST = "SAST"

CheckSAST is the registered name for SAST.

const CheckSecurityPolicy = "Security-Policy"

CheckSecurityPolicy is the registered name for SecurityPolicy.

const CheckSignedReleases = "Signed-Releases"

CheckSignedReleases is the registered name for SignedReleases.

const CheckTokenPermissions = "Token-Permissions"

CheckTokenPermissions is the exported name for Token-Permissions check.

const CheckVulnerabilities = "Vulnerabilities"

CheckVulnerabilities is the registered name for the OSV check.

const (
	// CheckWebHooks is the registered name for WebHooks.
	CheckWebHooks = "Webhooks"
)

Functions

func BinaryArtifacts

func BinaryArtifacts(c *checker.CheckRequest) checker.CheckResult

BinaryArtifacts will check the repository contains binary artifacts.

func BranchProtection

func BranchProtection(c *checker.CheckRequest) checker.CheckResult

BranchProtection runs the Branch-Protection check.

func CIIBestPractices

func CIIBestPractices(c *checker.CheckRequest) checker.CheckResult

CIIBestPractices will check if the maintainers have a best practice badge.

func CITests

func CITests(c *checker.CheckRequest) checker.CheckResult

func CodeReview

func CodeReview(c *checker.CheckRequest) checker.CheckResult

CodeReview will check if the maintainers perform code review.

func Contributors

func Contributors(c *checker.CheckRequest) checker.CheckResult

Contributors run Contributors check.

func DangerousWorkflow

func DangerousWorkflow(c *checker.CheckRequest) checker.CheckResult

DangerousWorkflow will check the repository contains Dangerous-Workflow.

func DependencyUpdateTool

func DependencyUpdateTool(c *checker.CheckRequest) checker.CheckResult

DependencyUpdateTool checks if the repository uses a dependency update tool.

func Fuzzing

func Fuzzing(c *checker.CheckRequest) checker.CheckResult

Fuzzing runs Fuzzing check.

func GetAll

func GetAll() checker.CheckNameToFnMap

GetAll returns the full list of default checks, excluding any experimental checks unless environment variable constraints are satisfied.

func GetAllWithExperimental

func GetAllWithExperimental() checker.CheckNameToFnMap

GetAllWithExperimental returns the full list of checks, including experimental checks.

func License

func License(c *checker.CheckRequest) checker.CheckResult

License runs License check.

func Maintained

func Maintained(c *checker.CheckRequest) checker.CheckResult

Maintained runs Maintained check.

func Packaging

func Packaging(c *checker.CheckRequest) checker.CheckResult

Packaging runs Packaging check.

func PinningDependencies

func PinningDependencies(c *checker.CheckRequest) checker.CheckResult

PinningDependencies will check the repository for its use of dependencies.

func SAST

func SAST(c *checker.CheckRequest) checker.CheckResult

SAST runs SAST check.

func SecurityPolicy

func SecurityPolicy(c *checker.CheckRequest) checker.CheckResult

SecurityPolicy runs Security-Policy check.

func SignedReleases

func SignedReleases(c *checker.CheckRequest) checker.CheckResult

SignedReleases runs Signed-Releases check.

func TokenPermissions

func TokenPermissions(c *checker.CheckRequest) checker.CheckResult

TokenPermissions will run the Token-Permissions check.

func Vulnerabilities

func Vulnerabilities(c *checker.CheckRequest) checker.CheckResult

Vulnerabilities runs Vulnerabilities check.

func WebHooks

func WebHooks(c *checker.CheckRequest) checker.CheckResult

WebHooks run Webhooks check.