all_checks.go

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

// Package checks defines all Scorecard checks.
package checks

import (
	"os"

	"github.com/ossf/scorecard/v5/checker"
)

// allChecks is the list of all registered security checks.
var allChecks = checker.CheckNameToFnMap{}

func getAll(overrideExperimental bool) checker.CheckNameToFnMap {
	// need to make a copy or caller could mutate original map
	possibleChecks := checker.CheckNameToFnMap{}
	for k, v := range allChecks {
		possibleChecks[k] = v
	}

	if overrideExperimental {
		return possibleChecks
	}

	if _, experimental := os.LookupEnv("SCORECARD_EXPERIMENTAL"); !experimental {
		// TODO: remove this check when v6 is released
		delete(possibleChecks, CheckWebHooks)
		delete(possibleChecks, CheckSBOM)
	}

	return possibleChecks
}

// GetAll returns the full list of default checks, excluding any experimental checks
// unless environment variable constraints are satisfied.
func GetAll() checker.CheckNameToFnMap {
	return getAll(false /*overrideExperimental*/)
}

// GetAllWithExperimental returns the full list of checks, including experimental checks.
func GetAllWithExperimental() checker.CheckNameToFnMap {
	return getAll(true /*overrideExperimental*/)
}

func registerCheck(name string, fn checker.CheckFn, supportedRequestTypes []checker.RequestType) error {
	if name == "" {
		return errInternalNameCannotBeEmpty
	}
	if fn == nil {
		return errInternalCheckFuncCannotBeNil
	}
	allChecks[name] = checker.Check{
		Fn:                    fn,
		SupportedRequestTypes: supportedRequestTypes,
	}
	return nil
}