src/testing/host-target-testing/avb/avb.go

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

package avb

import (
	"context"
	"fmt"
	"io"
	"os"
	"os/exec"
	"path/filepath"

	"go.fuchsia.dev/fuchsia/tools/lib/logger"
)

type AVBTool struct {
	avbToolPath     string
	keyPath         string
	keyMetadataPath string
	stdout          io.Writer
}

func NewAVBTool(avbToolPath string, keyPath string, keyMetadataPath string) (*AVBTool, error) {
	return newAVBToolWithStdout(avbToolPath, keyPath, keyMetadataPath, nil)
}

func newAVBToolWithStdout(avbToolPath string, keyPath string, keyMetadataPath string, stdout io.Writer) (*AVBTool, error) {
	if _, err := os.Stat(keyPath); err != nil {
		return nil, err
	}
	if _, err := os.Stat(keyMetadataPath); err != nil {
		return nil, err
	}
	return &AVBTool{
		avbToolPath:     avbToolPath,
		keyPath:         keyPath,
		keyMetadataPath: keyMetadataPath,
		stdout:          stdout,
	}, nil
}

func (a *AVBTool) MakeVBMetaImage(ctx context.Context, destPath string, srcPath string, propFiles map[string]string) error {
	path, err := exec.LookPath(a.avbToolPath)
	if err != nil {
		return err
	}

	args := []string{
		"make_vbmeta_image",
		"--output", destPath,
		"--key", a.keyPath,
		"--algorithm", "SHA512_RSA4096",
		"--public_key_metadata", a.keyMetadataPath,
		"--include_descriptors_from_image", srcPath,
	}

	for key, path := range propFiles {
		if _, err := os.Stat(path); err != nil {
			return err
		}

		args = append(args, "--prop_from_file", fmt.Sprintf("%s:%s", key, path))
	}

	logger.Infof(ctx, "running: %s %q", path, args)
	cmd := exec.CommandContext(ctx, path, args...)
	if a.stdout != nil {
		cmd.Stdout = a.stdout
	} else {
		cmd.Stdout = os.Stdout
	}
	cmd.Stderr = os.Stderr
	return cmd.Run()
}

func (a *AVBTool) MakeVBMetaImageWithZbi(ctx context.Context, destPath string, srcPath string, zbiPath string) error {
	tempDirForNewVbmeta, err := os.MkdirTemp("", "")

	if err != nil {
		return fmt.Errorf("failed to create temp diectory for vbmeta: %q", err)
	}
	defer os.RemoveAll(tempDirForNewVbmeta)

	pathToVbmetaDescFile := filepath.Join(tempDirForNewVbmeta, "vbmeta_desc")
	args := []string{
		"add_hash_footer",
		"--image", zbiPath,
		"--partition_name", "zircon",
		"--output_vbmeta_image", pathToVbmetaDescFile,
		"--do_not_append_vbmeta_image",
		"--partition_size",
		"209715200",
	}

	if err := a.runAvbCommand(ctx, args); err != nil {
		return fmt.Errorf("failed to create vbmeta desc file: %q", err)
	}

	args = []string{
		"make_vbmeta_image",
		"--output", destPath,
		"--key", a.keyPath,
		"--algorithm", "SHA512_RSA4096",
		"--public_key_metadata", a.keyMetadataPath,
		"--include_descriptors_from_image", pathToVbmetaDescFile,
	}

	return a.runAvbCommand(ctx, args)
}

func (a *AVBTool) runAvbCommand(ctx context.Context, args []string) error {
	path, err := exec.LookPath(a.avbToolPath)
	if err != nil {
		return err
	}

	logger.Infof(ctx, "running: %s %q", path, args)
	cmd := exec.CommandContext(ctx, path, args...)
	if a.stdout != nil {
		cmd.Stdout = a.stdout
	} else {
		cmd.Stdout = os.Stdout
	}
	cmd.Stderr = os.Stderr

	return cmd.Run()
}