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"
	"fmt"

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

var _ VulnerabilitiesClient = osvClient{}

type osvClient struct{}

// ListUnfixedVulnerabilities implements VulnerabilityClient.ListUnfixedVulnerabilities.
func (v osvClient) ListUnfixedVulnerabilities(
	ctx context.Context,
	commit,
	localPath string,
) (VulnerabilitiesResponse, error) {
	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,
	}, nil) // TODO: Do logging?
	if err != nil {
		return VulnerabilitiesResponse{}, fmt.Errorf("osvscanner.DoScan: %w", err)
	}

	response := VulnerabilitiesResponse{}
	vulns := res.Flatten()
	for i := range vulns {
		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
}

// 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
}