Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Phase 2 COSI Support #85

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Add Phase 2 COSI Support #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 141 additions & 50 deletions toolkit/tools/pkg/imagecustomizerlib/cosicommon.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package imagecustomizerlib
import (
"archive/tar"
"crypto/sha512"
_ "embed"
"encoding/json"
"fmt"
"io"
Expand All @@ -17,9 +16,10 @@ import (
)

type ImageBuildData struct {
Source string
KnownInfo outputPartitionMetadata
Metadata *Image
Source string
KnownInfo outputPartitionMetadata
Metadata *Image
VeritySource string
}

func convertToCosi(ic *ImageCustomizerParameters) error {
Expand All @@ -41,9 +41,9 @@ func convertToCosi(ic *ImageCustomizerParameters) error {
return err
}

err = buildCosiFile(outputDir, ic.outputImageFile, partitionMetadataOutput, ic.imageUuidStr)
err = buildCosiFile(outputDir, ic.outputImageFile, partitionMetadataOutput, ic.verityMetadata, ic.imageUuidStr)
if err != nil {
return fmt.Errorf("failed to build COSI:\n%w", err)
return fmt.Errorf("failed to build COSI file:\n%w", err)
}

logger.Log.Infof("Successfully converted to COSI: %s", ic.outputImageFile)
Expand All @@ -56,45 +56,90 @@ func convertToCosi(ic *ImageCustomizerParameters) error {
return nil
}

func buildCosiFile(sourceDir string, outputFile string, expectedImages []outputPartitionMetadata, imageUuidStr string) error {
metadata := MetadataJson{
Version: "1.0",
OsArch: runtime.GOARCH,
Id: imageUuidStr,
Images: make([]Image, len(expectedImages)),
func buildCosiFile(sourceDir string, outputFile string, partitions []outputPartitionMetadata, verityMetadata []verityDeviceMetadata, imageUuidStr string) error {

// Pre-compute a map for quick lookup of partition metadata by UUID
partUuidToMetadata := make(map[string]outputPartitionMetadata)
for _, partition := range partitions {
partUuidToMetadata[partition.PartUuid] = partition
}

if len(expectedImages) == 0 {
return fmt.Errorf("no images to build")
// Pre-compute a set of verity hash UUIDs for quick lookup
verityHashUuids := make(map[string]struct{})
for _, verity := range verityMetadata {
verityHashUuids[verity.hashPartUuid] = struct{}{}
}

// Create an interim metadata struct to combine the known data with the metadata
imageData := make([]ImageBuildData, len(expectedImages))
for i, image := range expectedImages {
metadata := &metadata.Images[i]
imageData[i] = ImageBuildData{
Source: path.Join(sourceDir, image.PartitionFilename),
Metadata: metadata,
KnownInfo: image,
imageData := []ImageBuildData{}

for _, partition := range partitions {
// Skip verity hash partitions as their metadata will be assigned to the corresponding data partitions
if _, isVerityHash := verityHashUuids[partition.PartUuid]; isVerityHash {
continue
}

metadataImage := Image{
Image: ImageFile{
Path: path.Join("images", partition.PartitionFilename),
UncompressedSize: partition.UncompressedSize,
},
PartType: partition.PartitionTypeUuid,
MountPoint: partition.Mountpoint,
FsType: partition.FileSystemType,
FsUuid: partition.Uuid,
}

imageDataEntry := ImageBuildData{
Source: path.Join(sourceDir, partition.PartitionFilename),
Metadata: &metadataImage,
KnownInfo: partition,
}

// Add Verity metadata if the partition has a matching entry in verityMetadata
for _, verity := range verityMetadata {
if partition.PartUuid == verity.dataPartUuid {
hashPartition, exists := partUuidToMetadata[verity.hashPartUuid]
if !exists {
return fmt.Errorf("missing metadata for hash partition UUID:\n%s", verity.hashPartUuid)
}

metadataImage.Verity = &Verity{
Hash: verity.hash,
Image: ImageFile{
Path: path.Join("images", hashPartition.PartitionFilename),
UncompressedSize: hashPartition.UncompressedSize,
},
}

veritySourcePath := path.Join(sourceDir, hashPartition.PartitionFilename)
imageDataEntry.VeritySource = veritySourcePath
break
}
}

metadata.Image.Path = path.Join("images", image.PartitionFilename)
metadata.PartType = image.PartitionTypeUuid
metadata.MountPoint = image.Mountpoint
metadata.FsType = image.FileSystemType
metadata.FsUuid = image.Uuid
metadata.UncompressedSize = image.UncompressedSize
imageData = append(imageData, imageDataEntry)
}

// Populate metadata for each image
for _, data := range imageData {
logger.Log.Infof("Processing image %s", data.Source)
err := populateMetadata(data)
for i := range imageData {
err := populateMetadata(&imageData[i])
if err != nil {
return fmt.Errorf("failed to populate metadata for %s:\n%w", data.Source, err)
return fmt.Errorf("failed to populate metadata for %s:\n%w", imageData[i].Source, err)
}

logger.Log.Infof("Populated metadata for image %s", data.Source)
logger.Log.Infof("Populated metadata for image %s", imageData[i].Source)
}

metadata := MetadataJson{
Version: "1.0",
OsArch: runtime.GOARCH,
Id: imageUuidStr,
Images: make([]Image, len(imageData)),
}

// Copy updated metadata
for i, data := range imageData {
metadata.Images[i] = *data.Metadata
}

// Marshal metadata.json
Expand Down Expand Up @@ -133,26 +178,43 @@ func buildCosiFile(sourceDir string, outputFile string, expectedImages []outputP
}

func addToCosi(data ImageBuildData, tw *tar.Writer) error {
imageFile, err := os.Open(data.Source)
err := addFileToCosi(tw, data.Source, data.Metadata.Image)
if err != nil {
return fmt.Errorf("failed to add image file to COSI:\n%w", err)
}

if data.VeritySource != "" && data.Metadata.Verity != nil {
err := addFileToCosi(tw, data.VeritySource, data.Metadata.Verity.Image)
if err != nil {
return fmt.Errorf("failed to add verity file to COSI:\n%w", err)
}
}

return nil
}

func addFileToCosi(tw *tar.Writer, source string, image ImageFile) error {
file, err := os.Open(source)
if err != nil {
return fmt.Errorf("failed to open image file:\n%w", err)
return fmt.Errorf("failed to open file :\n%w", err)
}
defer imageFile.Close()
defer file.Close()

err = tw.WriteHeader(&tar.Header{
Typeflag: tar.TypeReg,
Name: data.Metadata.Image.Path,
Size: int64(data.Metadata.Image.CompressedSize),
Name: image.Path,
Size: int64(image.CompressedSize),
Mode: 0o400,
Format: tar.FormatPAX,
})

if err != nil {
return fmt.Errorf("failed to write tar header:\n%w", err)
return fmt.Errorf("failed to write tar header for file '%s':\n%w", image.Path, err)
}

_, err = io.Copy(tw, imageFile)
_, err = io.Copy(tw, file)
if err != nil {
return fmt.Errorf("failed to write image to COSI:\n%w", err)
return fmt.Errorf("failed to write image '%s' to COSI:\n%w", image.Path, err)
}

return nil
Expand All @@ -172,21 +234,50 @@ func sha384sum(path string) (string, error) {
return fmt.Sprintf("%x", sha384.Sum(nil)), nil
}

func populateMetadata(data ImageBuildData) error {
stat, err := os.Stat(data.Source)
func populateImageFile(source string, imageFile *ImageFile) error {
stat, err := os.Stat(source)
if err != nil {
return fmt.Errorf("filed to stat %s:\n%w", data.Source, err)
return fmt.Errorf("failed to stat %s:\n%w", source, err)
}
if stat.IsDir() {
return fmt.Errorf("%s is a directory", data.Source)
return fmt.Errorf("%s is a directory", source)
}
data.Metadata.Image.CompressedSize = uint64(stat.Size())
imageFile.CompressedSize = uint64(stat.Size())

// Calculate the sha384 of the image
sha384, err := sha384sum(data.Source)
sha384, err := sha384sum(source)
if err != nil {
return fmt.Errorf("failed to calculate sha384 of %s:\n%w", data.Source, err)
return fmt.Errorf("failed to calculate sha384 of %s:\n%w", source, err)
}
imageFile.Sha384 = sha384

return nil
}

// Enriches the image metadata with size and checksum
func populateMetadata(data *ImageBuildData) error {
if err := populateImageFile(data.Source, &data.Metadata.Image); err != nil {
return fmt.Errorf("failed to populate metadata:\n%w", err)
}

if err := populateVerityMetadata(data.VeritySource, data.Metadata.Verity); err != nil {
return fmt.Errorf("failed to populate verity metadata:\n%w", err)
}
data.Metadata.Image.Sha384 = sha384

return nil
}

func populateVerityMetadata(source string, verity *Verity) error {
if source == "" && verity == nil {
return nil
}

if source == "" || verity == nil {
return fmt.Errorf("verity source and verity metadata must be both defined or both undefined")
}

if err := populateImageFile(source, &verity.Image); err != nil {
return fmt.Errorf("failed to populate verity image metadata:\n%w", err)
}

return nil
}
17 changes: 8 additions & 9 deletions toolkit/tools/pkg/imagecustomizerlib/cosimetadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,17 @@ type MetadataJson struct {
}

type Image struct {
Image ImageFile `json:"image"`
MountPoint string `json:"mountPoint"`
FsType string `json:"fsType"`
FsUuid string `json:"fsUuid"`
PartType string `json:"partType"`
Verity *Verity `json:"verity"`
UncompressedSize uint64 `json:"uncompressedSize"`
Image ImageFile `json:"image"`
MountPoint string `json:"mountPoint"`
FsType string `json:"fsType"`
FsUuid string `json:"fsUuid"`
PartType string `json:"partType"`
Verity *Verity `json:"verity"`
}

type Verity struct {
Image ImageFile `json:"image"`
Roothash string `json:"roothash"`
Image ImageFile `json:"image"`
Hash string `json:"hash"`
}

type ImageFile struct {
Expand Down
Loading
Loading