Commit ef7f2889 authored by Adrian Sutton's avatar Adrian Sutton

op-program: Verify loaded preimage matches requested key

Avoids errors in the preimage oracle (e.g. disk faults) from silently resulting in invalid execution.
parent 13a12557
package preimage
import (
"errors"
"fmt"
"slices"
)
var (
ErrIncorrectData = errors.New("incorrect data")
ErrUnsupportedKeyType = errors.New("unsupported key type")
)
// WithVerification wraps the supplied source to verify that the returned data is a valid pre-image for the key.
func WithVerification(source PreimageGetter) PreimageGetter {
return func(key [32]byte) ([]byte, error) {
data, err := source(key)
if err != nil {
return nil, err
}
switch KeyType(key[0]) {
case LocalKeyType:
return data, nil
case Keccak256KeyType:
hash := Keccak256(data)
if !slices.Equal(hash[1:], key[1:]) {
return nil, fmt.Errorf("%w for key %v, hash: %v data: %x", ErrIncorrectData, key, hash, data)
}
return data, nil
default:
return nil, fmt.Errorf("%w: %v", ErrUnsupportedKeyType, key[0])
}
}
}
package preimage
import (
"errors"
"testing"
"github.com/stretchr/testify/require"
)
func TestWithVerification(t *testing.T) {
validData := []byte{1, 2, 3, 4, 5, 6}
keccak256Key := Keccak256Key(Keccak256(validData))
anError := errors.New("boom")
tests := []struct {
name string
key Key
data []byte
err error
expectedErr error
expectedData []byte
}{
{
name: "LocalKey NoVerification",
key: LocalIndexKey(1),
data: []byte{4, 3, 5, 7, 3},
expectedData: []byte{4, 3, 5, 7, 3},
},
{
name: "Keccak256 Valid",
key: keccak256Key,
data: validData,
expectedData: validData,
},
{
name: "Keccak256 Error",
key: keccak256Key,
data: validData,
err: anError,
expectedErr: anError,
},
{
name: "Keccak256 InvalidData",
key: keccak256Key,
data: []byte{6, 7, 8},
expectedErr: ErrIncorrectData,
},
{
name: "EmptyData",
key: keccak256Key,
data: []byte{},
expectedErr: ErrIncorrectData,
},
{
name: "UnknownKey",
key: invalidKey([32]byte{0xaa}),
data: []byte{},
expectedErr: ErrUnsupportedKeyType,
},
}
for _, test := range tests {
test := test
t.Run(test.name, func(t *testing.T) {
source := WithVerification(func(key [32]byte) ([]byte, error) {
return test.data, test.err
})
actual, err := source(test.key.PreimageKey())
require.ErrorIs(t, err, test.expectedErr)
require.Equal(t, test.expectedData, actual)
})
}
}
type invalidKey [32]byte
func (k invalidKey) PreimageKey() (out [32]byte) {
out = k // copy the source hash
out[0] = byte(254) // apply invalid prefix
return
}
......@@ -174,7 +174,7 @@ func PreimageServer(ctx context.Context, logger log.Logger, cfg *config.Config,
localPreimageSource := kvstore.NewLocalPreimageSource(cfg)
splitter := kvstore.NewPreimageSourceSplitter(localPreimageSource.Get, getPreimage)
preimageGetter := splitter.Get
preimageGetter := preimage.WithVerification(splitter.Get)
serverDone = launchOracleServer(logger, preimageChannel, preimageGetter)
hinterDone = routeHints(logger, hintChannel, hinter)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment