From 25edff28708dda1044f6a9c8e2e8c782e114dce9 Mon Sep 17 00:00:00 2001
From: Lei Jitang <leijitang@huawei.com>
Date: Tue, 25 Oct 2016 02:22:41 -0400
Subject: [PATCH] Validate oci-layout version

OCI image specification has required that
`"oci-layout" MUST contain a JSON object with a version field {"imageLayoutVersion": "1.0.0"}`,
the image tool should follow this rule.

Signed-off-by: Lei Jitang <leijitang@huawei.com>
---
 image/image.go | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/image/image.go b/image/image.go
index 1551c1c..d364e21 100644
--- a/image/image.go
+++ b/image/image.go
@@ -17,6 +17,8 @@ package image
 import (
 	"encoding/json"
 	"fmt"
+	"io"
+	"io/ioutil"
 	"log"
 	"os"
 	"path/filepath"
@@ -25,6 +27,14 @@ import (
 	"github.com/pkg/errors"
 )
 
+// ImageLayout the structure in the "oci-layout" file
+// TODO: this has beed defined in image-spec,
+// needs a rebase after vendoring image-spec to v1.0.0-rc2
+// to just reference image-spec.
+type Layout struct {
+	Version string `json:"imageLayoutVersion"`
+}
+
 // ValidateLayout walks through the given file tree and validates the manifest
 // pointed to by the given refs or returns an error if the validation failed.
 func ValidateLayout(src string, refs []string, out *log.Logger) error {
@@ -49,6 +59,9 @@ var validRefMediaTypes = []string{
 }
 
 func validate(w walker, refs []string, out *log.Logger) error {
+	if err := validateImageLayout(w); err != nil {
+		return err
+	}
 	ds, err := listReferences(w)
 	if err != nil {
 		return err
@@ -94,6 +107,37 @@ func validate(w walker, refs []string, out *log.Logger) error {
 	return nil
 }
 
+func validateImageLayout(w walker) error {
+	mpath := "oci-layout"
+	imageLayout := &Layout{}
+	switch err := w.walk(func(path string, info os.FileInfo, r io.Reader) error {
+		if info.IsDir() || filepath.Clean(path) != mpath {
+			return nil
+		}
+		buf, err := ioutil.ReadAll(r)
+		if err != nil {
+			return errors.Wrapf(err, "error reading oci-layout")
+		}
+
+		if err := json.Unmarshal(buf, &imageLayout); err != nil {
+			return err
+		}
+		if imageLayout.Version != "1.0.0" {
+			return fmt.Errorf("imageLayout version %s mismatch with required version 1.0.0", imageLayout.Version)
+		}
+
+		return errEOW
+	}); err {
+	case nil:
+		return fmt.Errorf("oci-layout not found")
+	case errEOW:
+		return nil
+	default:
+		return err
+	}
+
+}
+
 // UnpackLayout walks through the file tree given by src and, using the layers
 // specified in the manifest pointed to by the given ref, unpacks all layers in
 // the given destination directory or returns an error if the unpacking failed.
@@ -115,6 +159,10 @@ func Unpack(tarFile, dest, ref string) error {
 }
 
 func unpack(w walker, dest, refName string) error {
+	if err := validateImageLayout(w); err != nil {
+		return err
+	}
+
 	ref, err := findDescriptor(w, refName)
 	if err != nil {
 		return err
@@ -157,6 +205,10 @@ func CreateRuntimeBundle(tarFile, dest, ref, root string) error {
 }
 
 func createRuntimeBundle(w walker, dest, refName, rootfs string) error {
+	if err := validateImageLayout(w); err != nil {
+		return err
+	}
+
 	ref, err := findDescriptor(w, refName)
 	if err != nil {
 		return err