raw

Documentation

Overview

Copyright 2022 OpenSSF Scorecard Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func BinaryArtifacts(req *checker.CheckRequest) (checker.BinaryArtifactData, error)
• func BranchProtection(cr *checker.CheckRequest) (checker.BranchProtectionsData, error)
• func CIIBestPractices(c *checker.CheckRequest) (checker.CIIBestPracticesData, error)
• func CITests(c clients.RepoClient) (checker.CITestData, error)
• func CodeReview(c clients.RepoClient) (checker.CodeReviewData, error)
• func Contributors(cr *checker.CheckRequest) (checker.ContributorsData, error)
• func DangerousWorkflow(c *checker.CheckRequest) (checker.DangerousWorkflowData, error)
• func DependencyUpdateTool(c clients.RepoClient) (checker.DependencyUpdateToolData, error)
• func Fuzzing(c *checker.CheckRequest) (checker.FuzzingData, error)
• func License(c *checker.CheckRequest) (checker.LicenseData, error)
• func Maintained(c *checker.CheckRequest) (checker.MaintainedData, error)
• func PinningDependencies(c *checker.CheckRequest) (checker.PinningDependenciesData, error)
• func SAST(c *checker.CheckRequest) (checker.SASTData, error)
• func SBOM(c *checker.CheckRequest) (checker.SBOMData, error)
• func SecurityPolicy(c *checker.CheckRequest) (checker.SecurityPolicyData, error)
• func SignedReleases(c *checker.CheckRequest) (checker.SignedReleasesData, error)
• func TestLicense(name string) bool
• func TokenPermissions(c *checker.CheckRequest) (checker.TokenPermissionsData, error)
• func Vulnerabilities(c *checker.CheckRequest) (checker.VulnerabilitiesData, error)
• func WebHook(c *checker.CheckRequest) (checker.WebhooksData, error)

Constants

const CheckSAST = "SAST"

Functions

func BinaryArtifacts

func BinaryArtifacts(req *checker.CheckRequest) (checker.BinaryArtifactData, error)

BinaryArtifacts retrieves the raw data for the Binary-Artifacts check.

func BranchProtection

func BranchProtection(cr *checker.CheckRequest) (checker.BranchProtectionsData, error)

BranchProtection retrieves the raw data for the Branch-Protection check.

func CIIBestPractices

func CIIBestPractices(c *checker.CheckRequest) (checker.CIIBestPracticesData, error)

CIIBestPractices retrieves the raw data for the CIIBestPractices check.

func CITests

func CITests(c clients.RepoClient) (checker.CITestData, error)

func CodeReview

func CodeReview(c clients.RepoClient) (checker.CodeReviewData, error)

CodeReview retrieves the raw data for the Code-Review check.

func Contributors

func Contributors(cr *checker.CheckRequest) (checker.ContributorsData, error)

Contributors retrieves the raw data for the Contributors check.

func DangerousWorkflow

func DangerousWorkflow(c *checker.CheckRequest) (checker.DangerousWorkflowData, error)

DangerousWorkflow retrieves the raw data for the DangerousWorkflow check.

func DependencyUpdateTool

func DependencyUpdateTool(c clients.RepoClient) (checker.DependencyUpdateToolData, error)

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

func Fuzzing

func Fuzzing(c *checker.CheckRequest) (checker.FuzzingData, error)

Fuzzing runs Fuzzing check.

func License

func License(c *checker.CheckRequest) (checker.LicenseData, error)

License retrieves the raw data for the License check.

func Maintained

func Maintained(c *checker.CheckRequest) (checker.MaintainedData, error)

Maintained checks for maintenance.

func PinningDependencies

func PinningDependencies(c *checker.CheckRequest) (checker.PinningDependenciesData, error)

PinningDependencies checks for (un)pinned dependencies.

func SAST

func SAST(c *checker.CheckRequest) (checker.SASTData, error)

SAST checks for presence of static analysis tools.

func SBOM

func SBOM(c *checker.CheckRequest) (checker.SBOMData, error)

SBOM retrieves the raw data for the SBOM check.

func SecurityPolicy

func SecurityPolicy(c *checker.CheckRequest) (checker.SecurityPolicyData, error)

SecurityPolicy checks for presence of security policy and applicable content discovered by checkSecurityPolicyFileContent().

func SignedReleases

func SignedReleases(c *checker.CheckRequest) (checker.SignedReleasesData, error)

SignedReleases checks for presence of signed release check.

func TestLicense

func TestLicense(name string) bool

TestLicense used for testing purposes.

func TokenPermissions

func TokenPermissions(c *checker.CheckRequest) (checker.TokenPermissionsData, error)

TokenPermissions runs Token-Permissions check.

func Vulnerabilities

func Vulnerabilities(c *checker.CheckRequest) (checker.VulnerabilitiesData, error)

Vulnerabilities retrieves the raw data for the Vulnerabilities check.

func WebHook

func WebHook(c *checker.CheckRequest) (checker.WebhooksData, error)

WebHook retrieves the raw data for the WebHooks check.