blob_test.go 8.42 KB
Newer Older
1 2 3
package eth

import (
4
	"math/rand"
5
	"testing"
6 7

	"github.com/stretchr/testify/require"
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
)

func TestBlobEncodeDecode(t *testing.T) {
	cases := []string{
		"this is a test of blob encoding/decoding",
		"short",
		"\x00",
		"\x00\x01\x00",
		"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00",
		"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00",
		"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00",
		"",
	}

	var b Blob
	for _, c := range cases {
		data := Data(c)
25 26
		err := b.FromData(data)
		require.NoError(t, err)
27
		decoded, err := b.ToData()
28 29
		require.NoError(t, err)
		require.Equal(t, c, string(decoded))
30 31 32
	}
}

33 34 35 36 37 38 39 40 41 42 43 44 45 46
func TestSmallBlobEncoding(t *testing.T) {
	// the first field element is filled and no data remains
	data := Data(make([]byte, 128))
	data[127] = 0xFF

	var b Blob
	err := b.FromData(data)
	require.NoError(t, err)

	decoded, err := b.ToData()
	require.NoError(t, err)
	require.Equal(t, data, decoded)

	// only 10 bytes of data
47
	data = Data(make([]byte, 10))
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
	data[9] = 0xFF
	err = b.FromData(data)
	require.NoError(t, err)
	decoded, err = b.ToData()
	require.NoError(t, err)
	require.Equal(t, data, decoded)

	// no 3 bytes of extra data left to encode after the first 4 field elements
	data = Data(make([]byte, 27+31*3))
	data[27+31*3-1] = 0xFF
	err = b.FromData(data)
	require.NoError(t, err)
	decoded, err = b.ToData()
	require.NoError(t, err)
	require.Equal(t, data, decoded)
}

65
func TestBigBlobEncoding(t *testing.T) {
66
	r := rand.New(rand.NewSource(99))
67
	bigData := Data(make([]byte, MaxBlobDataSize))
68 69
	for i := range bigData {
		bigData[i] = byte(r.Intn(256))
70
	}
71 72 73 74
	var b Blob
	// test the maximum size of data that can be encoded
	err := b.FromData(bigData)
	require.NoError(t, err)
75
	decoded, err := b.ToData()
76 77 78 79 80 81 82 83 84 85 86 87 88
	require.NoError(t, err)
	require.Equal(t, bigData, decoded)

	// perform encode/decode test on progressively smaller inputs to exercise boundary conditions
	// pertaining to length of the input data
	for i := 1; i < 256; i++ {
		tempBigData := bigData[i:]
		err := b.FromData(tempBigData)
		require.NoError(t, err)
		decoded, err := b.ToData()
		require.NoError(t, err)
		require.Equal(t, len(tempBigData), len(decoded))
		require.Equal(t, tempBigData, decoded)
89 90 91 92 93 94 95 96 97
	}
}

func TestInvalidBlobDecoding(t *testing.T) {
	data := Data("this is a test of invalid blob decoding")
	var b Blob
	if err := b.FromData(data); err != nil {
		t.Fatalf("failed to encode bytes: %v", err)
	}
98

99
	b[32] = 0b10000000 // field elements should never have their highest order bit set
100 101 102
	_, err := b.ToData()
	require.ErrorIs(t, err, ErrBlobInvalidFieldElement)
	b[32] = 0x0
103

104 105 106 107 108
	b[32] = 0b01000000 // field elements should never have their second highest order bit set
	_, err = b.ToData()
	require.ErrorIs(t, err, ErrBlobInvalidFieldElement)
	b[32] = 0x0

109 110 111 112 113 114 115 116
	b[VersionOffset] = 0x01 // invalid encoding version
	_, err = b.ToData()
	require.ErrorIs(t, err, ErrBlobInvalidEncodingVersion)
	b[VersionOffset] = EncodingVersion

	b[2] = 0xFF // encode an invalid (much too long) length prefix
	_, err = b.ToData()
	require.ErrorIs(t, err, ErrBlobInvalidLength)
117 118 119 120 121 122 123 124
}

func TestTooLongDataEncoding(t *testing.T) {
	// should never be able to encode data that has size the same as that of the blob due to < 256
	// bit precision of each field element
	data := Data(make([]byte, BlobSize))
	var b Blob
	err := b.FromData(data)
125 126 127 128 129 130 131 132 133 134 135 136 137 138
	require.ErrorIs(t, err, ErrBlobInputTooLarge)
}

func FuzzEncodeDecodeBlob(f *testing.F) {
	var b Blob
	f.Fuzz(func(t *testing.T, d []byte) {
		b.Clear()
		data := Data(d)
		err := b.FromData(data)
		require.NoError(t, err)
		decoded, err := b.ToData()
		require.NoError(t, err)
		require.Equal(t, data, decoded)
	})
139
}
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
func FuzzDetectNonBijectivity(f *testing.F) {
	var b Blob
	r := rand.New(rand.NewSource(99))
	f.Fuzz(func(t *testing.T, d []byte) {
		b.Clear()
		data := Data(d)
		err := b.FromData(data)
		require.NoError(t, err)
		// randomly flip a bit and make sure the data either fails to decode or decodes differently
		byteToFlip := r.Intn(BlobSize)
		bitToFlip := r.Intn(8)
		mask := byte(1 << bitToFlip)
		b[byteToFlip] = b[byteToFlip] ^ mask
		decoded, err := b.ToData()
		if err != nil {
			require.NotEqual(t, data, decoded)
		}
	})
}

func TestDecodeTestVectors(t *testing.T) {
	cases := []struct {
		input, output string
		err           error
	}{
		{
			// an empty blob has version 0 and length 0, so is valid and will decode as empty output
			input:  "",
			output: "",
		},
		{
			// encode len==1, so should get one zero byte output
			input:  "\x00\x00\x00\x00\x01",
			output: "\x00",
		},
		{
			// encode len==130044 (0x01FBFC), max blob capacity, so should get 130044 zero bytes
			// for output
			input:  "\x00\x00\x01\xFB\xFC",
			output: string(make([]byte, 130044)),
		},
		{
			// encode len==130045 (0x01FBFD) which is greater than blob capacity, blob invalid
			input: "\x00\x00\x01\xFB\xFD",
			err:   ErrBlobInvalidLength,
		},
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
		{
			// encode len=10
			input:  "\x00\x00\x00\x00\x0a\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff",
			output: "\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff",
		},
		{
			// decode what should be 27 0xFF bytes
			input:  "\x00\x00\x00\x00\x1b\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff",
			output: "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff",
		},
		{
			// decode what should be 32 0xFF bytes
			input:  "\x3f\x00\x00\x00\x20\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\x30\xff\xff\xff\xff",
			output: "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff",
		},
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
	}

	var b Blob
	for _, c := range cases {
		b.Clear()
		copy(b[:], []byte(c.input))
		decoded, err := b.ToData()
		if c.err != nil {
			require.ErrorIs(t, err, c.err)
		} else {
			require.NoError(t, err)
			require.Equal(t, len(c.output), len(decoded))
			require.Equal(t, c.output, string(decoded))
		}
	}
}

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
func TestEncodeTestVectors(t *testing.T) {
	cases := []struct {
		input, output string
		err           error
	}{
		{
			// empty (all zeros) blob should decode as empty string
			input:  "",
			output: "",
		},
		{
			// max input data
			input:  string(make([]byte, MaxBlobDataSize)),
			output: "\x00\x00\x01\xfb\xfc",
		},
		{
			// input data too big
			input:  string(make([]byte, MaxBlobDataSize+1)),
			output: "",
			err:    ErrBlobInputTooLarge,
		},
		{
			// 27 bytes each with high order bits set (should cleanly fit in the first FE along with the version+length)
			input:  "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff",
			output: "\x00\x00\x00\x00\x1b\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff",
		},
		{
			// 28 bytes each with high order bits set, requires high bits spilling into byte 0 and last byte
			input:  "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff",
			output: "\x3f\x00\x00\x00\x1c\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\x30",
		},
	}

	var b, testBlob Blob
	for _, c := range cases {
		err := b.FromData(Data(c.input))
		if c.err != nil {
			require.ErrorIs(t, err, c.err)
		} else {
			require.NoError(t, err)
			testBlob.Clear()
			copy(testBlob[:], []byte(c.output))
			require.Equal(t, testBlob, b)
		}
	}
}

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
func TestExtraneousData(t *testing.T) {
	var b Blob
	// make sure 0 length blob with non-zero bits in upper byte are detected & rejected
	input := "\x30\x00\x00\x00\x00"
	copy(b[:], []byte(input))
	_, err := b.ToData()
	require.ErrorIs(t, err, ErrBlobExtraneousDataFieldElement)
	input = "\x01\x00\x00\x00\x00"
	copy(b[:], []byte(input))
	_, err = b.ToData()
	require.ErrorIs(t, err, ErrBlobExtraneousDataFieldElement)
	b.Clear()
	i := len(input)

	// make sure non-zero bytes in blob following the encoded length are detected & rejected
	for ; i < 128; i++ {
		b[i-1] = 0
		b[i] = 0x01
		decoded, err := b.ToData()
		require.ErrorIs(t, err, ErrBlobExtraneousDataFieldElement, len(decoded))
	}
	for ; i < BlobSize; i += 7 { // increment by 7 bytes each iteration so the test isn't too slow
		b[i-1] = 0
		b[i] = 1
		decoded, err := b.ToData()
		require.ErrorIs(t, err, ErrBlobExtraneousData, len(decoded))
	}
}