scorecard/clients/osv.go

// Copyright 2021 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 clients

import (
	"context"
	"errors"
	"fmt"
	"os"
	"runtime/debug"

	"github.com/google/osv-scanner/pkg/osvscanner"

	sce "github.com/ossf/scorecard/v5/errors"
)

var _ VulnerabilitiesClient = osvClient{}

type osvClient struct {
	local bool
}

// ListUnfixedVulnerabilities implements VulnerabilityClient.ListUnfixedVulnerabilities.
func (v osvClient) ListUnfixedVulnerabilities(
	ctx context.Context,
	commit,
	localPath string,
) (_ VulnerabilitiesResponse, err error) {
	defer func() {
		if r := recover(); r != nil {
			err = sce.CreateInternal(sce.ErrScorecardInternal, fmt.Sprintf("osv-scanner panic: %v", r))
			fmt.Fprintf(os.Stderr, "osv-scanner panic: %v\n%s\n", r, string(debug.Stack()))
		}
	}()
	directoryPaths := []string{}
	if localPath != "" {
		directoryPaths = append(directoryPaths, localPath)
	}
	gitCommits := []string{}
	if commit != "" {
		gitCommits = append(gitCommits, commit)
	}
	res, err := osvscanner.DoScan(osvscanner.ScannerActions{
		DirectoryPaths: directoryPaths,
		SkipGit:        true,
		Recursive:      true,
		GitCommits:     gitCommits,
		ExperimentalScannerActions: osvscanner.ExperimentalScannerActions{
			CompareOffline:    v.local,
			DownloadDatabases: v.local,
		},
	}, nil) // TODO: Do logging?

	response := VulnerabilitiesResponse{}

	// either no vulns found, or no packages detected by osvscanner, which likely means no vulns
	// while there could still be vulns, not detecting any packages shouldn't be a runtime error.
	if err == nil || errors.Is(err, osvscanner.NoPackagesFoundErr) {
		return response, nil
	}

	// If vulnerabilities are found, err will be set to osvscanner.VulnerabilitiesFoundErr
	if errors.Is(err, osvscanner.VulnerabilitiesFoundErr) {
		vulns := res.Flatten()
		for i := range vulns {
			// ignore Go stdlib vulns. The go directive from the go.mod isn't a perfect metric
			// of which version of Go will be used to build a project.
			if vulns[i].Package.Ecosystem == "Go" && vulns[i].Package.Name == "stdlib" {
				continue
			}
			response.Vulnerabilities = append(response.Vulnerabilities, Vulnerability{
				ID:      vulns[i].Vulnerability.ID,
				Aliases: vulns[i].Vulnerability.Aliases,
			})
			// Remove duplicate vulnerability IDs for now as we don't report information
			// on the source of each vulnerability yet, therefore having multiple identical
			// vuln IDs might be confusing.
			response.Vulnerabilities = removeDuplicate(
				response.Vulnerabilities,
				func(key Vulnerability) string { return key.ID },
			)
		}

		return response, nil
	}

	return VulnerabilitiesResponse{}, fmt.Errorf("osvscanner.DoScan: %w", err)
}

// RemoveDuplicate removes duplicate entries from a slice.
func removeDuplicate[T any, K comparable](sliceList []T, keyExtract func(T) K) []T {
	allKeys := make(map[K]bool)
	list := []T{}
	for _, item := range sliceList {
		key := keyExtract(item)
		if _, value := allKeys[key]; !value {
			allKeys[key] = true
			list = append(list, item)
		}
	}
	return list
}