File: state.go

package info (click to toggle)
golang-github-transparency-dev-tessera 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 3,568 kB
  • sloc: sql: 33; sh: 17; makefile: 14
file content (93 lines) | stat: -rw-r--r-- 3,076 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
// Copyright 2024 Google LLC. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package api contains the tiles definitions from the [tlog-tiles API].
//
// [tlog-tiles API]: https://c2sp.org/tlog-tiles
package api

import (
	"bytes"
	"crypto/sha256"
	"encoding/binary"
	"fmt"

	"github.com/transparency-dev/tessera/api/layout"
)

// HashTile represents a tile within the Merkle hash tree.
// Leaf HashTiles will have a corresponding EntryBundle, where each
// entry in the EntryBundle slice hashes to the value at the same
// index in the Nodes slice.
type HashTile struct {
	// Nodes stores the leaf hash nodes in this tile.
	// Note that only non-ephemeral nodes are stored.
	Nodes [][]byte
}

// MarshalText implements encoding/TextMarshaller and writes out an HashTile
// instance as sequences of concatenated hashes as specified by the tlog-tiles spec.
func (t HashTile) MarshalText() ([]byte, error) {
	r := &bytes.Buffer{}
	for _, n := range t.Nodes {
		if _, err := r.Write(n); err != nil {
			return nil, err
		}
	}
	return r.Bytes(), nil
}

// UnmarshalText implements encoding/TextUnmarshaler and reads HashTiles
// which are encoded using the tlog-tiles spec.
func (t *HashTile) UnmarshalText(raw []byte) error {
	if len(raw)%sha256.Size != 0 {
		return fmt.Errorf("%d is not a multiple of %d", len(raw), sha256.Size)
	}
	nodes := make([][]byte, 0, len(raw)/sha256.Size)
	for index := 0; index < len(raw); index += sha256.Size {
		data := raw[index : index+sha256.Size]
		nodes = append(nodes, data)
	}
	t.Nodes = nodes
	return nil
}

// EntryBundle represents a sequence of entries in the log.
// These entries correspond to a leaf tile in the hash tree.
type EntryBundle struct {
	// Entries stores the leaf entries of the log, in order.
	Entries [][]byte
}

// UnmarshalText implements encoding/TextUnmarshaler and reads EntryBundles
// which are encoded using the tlog-tiles spec.
func (t *EntryBundle) UnmarshalText(raw []byte) error {
	nodes := make([][]byte, 0, layout.EntryBundleWidth)
	for index := 0; index < len(raw); {
		dataIndex := index + 2
		if dataIndex > len(raw) {
			return fmt.Errorf("dangling bytes at byte index %d in data of %d bytes", index, len(raw))
		}
		size := int(binary.BigEndian.Uint16(raw[index:dataIndex]))
		dataEnd := dataIndex + size
		if dataEnd > len(raw) {
			return fmt.Errorf("require %d bytes from byte index %d, but size is %d", size, dataIndex, len(raw))
		}
		data := raw[dataIndex:dataEnd]
		nodes = append(nodes, data)
		index = dataIndex + size
	}
	t.Entries = nodes
	return nil
}