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.

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

Fix ReadDMVeritySuperBlock function #1257

Merged
merged 4 commits into from
Jan 13, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
11 changes: 7 additions & 4 deletions ext4/dmverity/dmverity.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ var (
ErrSuperBlockReadFailure = errors.New("failed to read dm-verity super block")
ErrSuperBlockParseFailure = errors.New("failed to parse dm-verity super block")
ErrRootHashReadFailure = errors.New("failed to read dm-verity root hash")
ErrNotVeritySuperBlock = errors.New("not dm-verity super-block")
anmaxvl marked this conversation as resolved.
Show resolved Hide resolved
)

type dmveritySuperblock struct {
Expand Down Expand Up @@ -173,21 +174,23 @@ func ReadDMVerityInfo(vhdPath string, offsetInBytes int64) (*VerityInfo, error)
block := make([]byte, blockSize)
if s, err := vhd.Read(block); err != nil || s != blockSize {
if err != nil {
return nil, errors.Wrapf(ErrSuperBlockReadFailure, "%s", err)
return nil, errors.Wrapf(err, "%s", ErrSuperBlockReadFailure)
}
return nil, errors.Wrapf(ErrSuperBlockReadFailure, "unexpected bytes read: expected=%d, actual=%d", blockSize, s)
}

dmvSB := &dmveritySuperblock{}
b := bytes.NewBuffer(block)
if err := binary.Read(b, binary.LittleEndian, dmvSB); err != nil {
return nil, errors.Wrapf(ErrSuperBlockParseFailure, "%s", err)
return nil, errors.Wrapf(err, "%s", ErrSuperBlockParseFailure)
}
if string(bytes.Trim(dmvSB.Signature[:], "\x00")[:]) != "verity" {
anmaxvl marked this conversation as resolved.
Show resolved Hide resolved
return nil, ErrNotVeritySuperBlock
}

// read the merkle tree root
if s, err := vhd.Read(block); err != nil || s != blockSize {
if err != nil {
return nil, errors.Wrapf(ErrRootHashReadFailure, "%s", err)
return nil, errors.Wrapf(err, "%s", ErrRootHashReadFailure)
}
return nil, errors.Wrapf(ErrRootHashReadFailure, "unexpected bytes read: expected=%d, actual=%d", blockSize, s)
}
Expand Down
102 changes: 102 additions & 0 deletions ext4/dmverity/dmverity_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
package dmverity

import (
"bytes"
"encoding/binary"
"io"
"io/ioutil"
"math/rand"
"os"
"strings"
"testing"
"unsafe"

"github.com/pkg/errors"
)

func tempFileWithContentLength(t *testing.T, length int) *os.File {
tmpFile, err := ioutil.TempFile("", "")
if err != nil {
t.Fatalf("failed to create temp file")
}
defer tmpFile.Close()

content := make([]byte, length)
if _, err := rand.Read(content); err != nil {
t.Fatalf("failed to write random bytes to buffer")
}
if _, err := tmpFile.Write(content); err != nil {
t.Fatalf("failed to write random bytes to temp file")
}
return tmpFile
}

func writeDMVeritySuperBlock(filename string) (*os.File, error) {
out, err := os.OpenFile(filename, os.O_RDWR, 0777)
if err != nil {
return nil, err
}
defer out.Close()
fsSize, err := out.Seek(0, io.SeekEnd)
if err != nil {
return nil, err
}
sb := NewDMVeritySuperblock(uint64(fsSize))
if err := binary.Write(out, binary.LittleEndian, sb); err != nil {
return nil, err
}
sbSize := int(unsafe.Sizeof(*sb))
padding := bytes.Repeat([]byte{0}, blockSize-(sbSize%blockSize))
if _, err = out.Write(padding); err != nil {
return nil, err
}
return out, nil
}

func TestInvalidReadEOF(t *testing.T) {
tmpFile := tempFileWithContentLength(t, blockSize)
_, err := ReadDMVerityInfo(tmpFile.Name(), blockSize)
if err == nil {
t.Fatalf("no error returned")
}
if errors.Cause(err) != io.EOF {
t.Fatalf("unexpected error: %s", err)
}
}

func TestInvalidReadNotEnoughBytes(t *testing.T) {
tmpFile := tempFileWithContentLength(t, blockSize+blockSize/2)
_, err := ReadDMVerityInfo(tmpFile.Name(), blockSize)
if err == nil {
t.Fatalf("no error returned")
}
if errors.Cause(err) != ErrSuperBlockReadFailure || !strings.Contains(err.Error(), "unexpected bytes read") {
t.Fatalf("unexpected error: %s", err)
}
}

func TestNotVeritySuperBlock(t *testing.T) {
tmpFile := tempFileWithContentLength(t, 2*blockSize)
_, err := ReadDMVerityInfo(tmpFile.Name(), blockSize)
if err == nil {
t.Fatalf("no error returned")
}
if err != ErrNotVeritySuperBlock {
t.Fatalf("expected %q, got %q", ErrNotVeritySuperBlock, err)
}
}

func TestNoMerkleTree(t *testing.T) {
tmpFile := tempFileWithContentLength(t, blockSize)
targetFile, err := writeDMVeritySuperBlock(tmpFile.Name())
if err != nil {
t.Fatalf("failed to write dm-verity super-block: %s", err)
}
_, err = ReadDMVerityInfo(targetFile.Name(), blockSize)
if err == nil {
t.Fatalf("no error returned")
}
if errors.Cause(err) != io.EOF || !strings.Contains(err.Error(), "failed to read dm-verity root hash") {
t.Fatalf("expected %q, got %q", io.EOF, err)
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.