scorecard/checks/security_policy.go

// Copyright 2020 Security 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.

package checks

import (
	"errors"
	"strings"

	"go.uber.org/zap"

	"github.com/ossf/scorecard/v2/checker"
	"github.com/ossf/scorecard/v2/clients/githubrepo"
	sce "github.com/ossf/scorecard/v2/errors"
)

// CheckSecurityPolicy is the registred name for SecurityPolicy.
const CheckSecurityPolicy = "Security-Policy"

//nolint:gochecknoinits
func init() {
	registerCheck(CheckSecurityPolicy, SecurityPolicy)
}

// SecurityPolicy runs Security-Policy check.
func SecurityPolicy(c *checker.CheckRequest) checker.CheckResult {
	var r bool
	// Check repository for repository-specific policy.
	onFile := func(name string, dl checker.DetailLogger, data FileCbData) (bool, error) {
		pdata := FileGetCbDataAsBoolPointer(data)
		if strings.EqualFold(name, "security.md") {
			c.Dlogger.Info3(&checker.LogMessage{
				Path: name,
				Type: checker.FileTypeSource,
				// Source file must have line number > 0.
				Offset: 1,
				Text:   "security policy detected",
			})
			*pdata = true
			return false, nil
		} else if isSecurityRstFound(name) {
			c.Dlogger.Info3(&checker.LogMessage{
				Path: name,
				Type: checker.FileTypeSource,
				// Source file must have line number > 0.
				Offset: 1,
				Text:   "security policy detected",
			})
			*pdata = true
			return false, nil
		}
		return true, nil
	}
	err := CheckIfFileExists(CheckSecurityPolicy, c, onFile, &r)
	if err != nil {
		return checker.CreateRuntimeErrorResult(CheckSecurityPolicy, err)
	}
	if r {
		return checker.CreateMaxScoreResult(CheckSecurityPolicy, "security policy file detected")
	}

	// checking for community default within the .github folder
	// https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file
	dotGitHub := c
	dotGitHub.Repo = ".github"
	logger, err := githubrepo.NewLogger(zap.InfoLevel)
	if err != nil {
		return checker.CreateRuntimeErrorResult(CheckSecurityPolicy, err)
	}
	dotGitHubClient := githubrepo.CreateGithubRepoClient(c.Ctx, logger)
	err = dotGitHubClient.InitRepo(c.Owner, c.Repo)

	switch {
	case err == nil:
		defer dotGitHubClient.Close()
		dotGitHub.RepoClient = dotGitHubClient
		onFile = func(name string, dl checker.DetailLogger, data FileCbData) (bool, error) {
			pdata := FileGetCbDataAsBoolPointer(data)
			if strings.EqualFold(name, "security.md") ||
				strings.EqualFold(name, ".github/security.md") ||
				strings.EqualFold(name, "docs/security.md") {
				dl.Info3(&checker.LogMessage{
					Path: name,
					Type: checker.FileTypeSource,
					// Source file must have line number > 0.
					Offset: 1,
					Text:   "security policy detected in .github folder",
				})
				*pdata = true
				return false, nil
			}
			return true, nil
		}
		err = CheckIfFileExists(CheckSecurityPolicy, dotGitHub, onFile, &r)
		if err != nil {
			return checker.CreateRuntimeErrorResult(CheckSecurityPolicy, err)
		}
		if r {
			return checker.CreateMaxScoreResult(CheckSecurityPolicy, "security policy file detected")
		}
	case !errors.Is(err, sce.ErrRepoUnreachable):
		return checker.CreateRuntimeErrorResult(CheckSecurityPolicy, err)
	}
	return checker.CreateMinScoreResult(CheckSecurityPolicy, "security policy file not detected")
}

func isSecurityRstFound(name string) bool {
	if strings.EqualFold(name, "doc/security.rst") {
		return true
	} else if strings.EqualFold(name, "docs/security.rst") {
		return true
	}
	return false
}