cmd/vulncheck_sandbox/vulncheck_sandbox.go

// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// This program runs vulncheck.Source or vulncheck.Binary on a module, then
// writes the result as JSON. It is intended to be run in a sandbox.
//
// Unless it panics, this program always terminates with exit code 0.
// If there is an error, it writes a JSON object with field "Error".
// Otherwise, it writes a vulncheck.Result as JSON.
package main

import (
	"context"
	"encoding/json"
	"errors"
	"flag"
	"fmt"
	"io"
	"log"
	"os"
	"os/exec"

	"golang.org/x/pkgsite-metrics/internal/load"
	"golang.org/x/pkgsite-metrics/internal/worker"
	"golang.org/x/vuln/vulncheck"
)

var (
	// vulnDBDir should contain a local copy of the vuln DB, with a LAST_MODIFIED
	// file containing a timestamp.
	vulnDBDir = flag.String("vulndb", "/go-vulndb", "directory of local vuln DB")

	clean = flag.Bool("clean", false, "clean caches instead of running a module")
)

func main() {
	flag.Parse()
	if *clean {
		cleanGoCaches()
	} else {
		run(os.Stdout, flag.Args(), *vulnDBDir)
	}
}

func run(w io.Writer, args []string, vulnDBDir string) {

	fail := func(err error) {
		fmt.Fprintf(w, `{"Error": %q}`, err)
		fmt.Fprintln(w)
	}

	res, err := runVulncheck(context.Background(), args, vulnDBDir)
	if err != nil {
		fail(err)
		return
	}
	b, err := json.MarshalIndent(res, "", "\t")
	if err != nil {
		fail(fmt.Errorf("json.MarshalIndent: %v", err))
		return
	}
	w.Write(b)
	fmt.Println()
}

func runVulncheck(ctx context.Context, args []string, vulnDBDir string) (*vulncheck.Result, error) {
	if len(args) != 2 {
		return nil, errors.New("need two args: mode, and module dir or binary")
	}
	mode := args[0]
	if !worker.IsValidVulncheckMode(mode) {
		return nil, fmt.Errorf("%q is not a valid mode", mode)
	}
	dbClient, err := NewLocalLMTClient(vulnDBDir)
	if err != nil {
		return nil, fmt.Errorf("NewLocalLMTClient: %v", err)
	}
	vcfg := &vulncheck.Config{
		Client:      dbClient,
		ImportsOnly: mode == worker.ModeImports,
	}

	if mode == worker.ModeBinary {
		binaryFilePath := args[1]
		binaryFile, err := os.Open(binaryFilePath)
		if err != nil {
			return nil, err
		}
		defer binaryFile.Close()
		return vulncheck.Binary(ctx, binaryFile, vcfg)
	}
	moduleDir := args[1]
	// Load all the packages in moduleDir.
	cfg := load.DefaultConfig()
	cfg.Dir = moduleDir
	cfg.Logf = log.Printf
	pkgs, pkgErrors, err := load.Packages(cfg, "./...")
	if err == nil && len(pkgErrors) > 0 {
		err = fmt.Errorf("%v", pkgErrors)
	}
	if err != nil {
		return nil, fmt.Errorf("loading packages: %v", err)
	}
	if len(pkgs) == 0 {
		return nil, fmt.Errorf("no packages in %s", moduleDir)
	}

	res, err := vulncheck.Source(ctx, vulncheck.Convert(pkgs), vcfg)
	if err != nil {
		return nil, err
	}
	if mode == worker.ModeVTAStacks {
		// Do this for effect only, to measure resources consumed.
		_ = vulncheck.CallStacks(res)
	}
	return res, nil

}

func cleanGoCaches() {
	_, err := exec.Command("go", "clean", "-cache", "-modcache").CombinedOutput()
	if err != nil {
		fmt.Fprintf(os.Stderr, "%s\n", err)
		os.Exit(1)
	}
	fmt.Printf("go clean succeeded in sandbox\n")
}