node/meta: deduplicate header verification

carpawell · carpawell · commit a6fc57db2ea5 · 2025-03-07T11:40:58.000+03:00
It is the same for metabase and metaservice. Index delimiter was also moved.

Signed-off-by: Pavel Karpy &lt;carpawell@nspcc.ru&gt;
diff --git a/pkg/core/object/metadata.go b/pkg/core/object/metadata.go
@@ -2,12 +2,14 @@ package object
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"math/big"
 	"slices"
 	"strings"
 
 	"github.com/nspcc-dev/neofs-sdk-go/client"
+	cid "github.com/nspcc-dev/neofs-sdk-go/container/id"
 	"github.com/nspcc-dev/neofs-sdk-go/object"
 	oid "github.com/nspcc-dev/neofs-sdk-go/object/id"
 	"github.com/nspcc-dev/neofs-sdk-go/user"
@@ -165,3 +167,33 @@ func calcMaxUniqueSearchResults(lim uint16, sets [][]client.SearchResultItem) ui
 	}
 	return n
 }
+
+// AttributeDelimiter is attribute key and value separator used in metadata DB.
+var AttributeDelimiter = []byte{0x00}
+
+// VerifyHeaderForMetadata checks whether given header corresponds to metadata
+// bucket requirements and limits.
+func VerifyHeaderForMetadata(hdr object.Object) error {
+	if ln := hdr.HeaderLen(); ln > object.MaxHeaderLen {
+		return fmt.Errorf("header len %d exceeds the limit", ln)
+	}
+	if hdr.GetContainerID().IsZero() {
+		return fmt.Errorf("invalid container: %w", cid.ErrZero)
+	}
+	if hdr.Owner().IsZero() {
+		return fmt.Errorf("invalid owner: %w", user.ErrZeroID)
+	}
+	if _, ok := hdr.PayloadChecksum(); !ok {
+		return errors.New("missing payload checksum")
+	}
+	attrs := hdr.Attributes()
+	for i := range attrs {
+		if strings.IndexByte(attrs[i].Key(), AttributeDelimiter[0]) >= 0 {
+			return fmt.Errorf("attribute #%d key contains 0x%02X byte used in sep", i, AttributeDelimiter[0])
+		}
+		if strings.IndexByte(attrs[i].Value(), AttributeDelimiter[0]) >= 0 {
+			return fmt.Errorf("attribute #%d value contains 0x%02X byte used in sep", i, AttributeDelimiter[0])
+		}
+	}
+	return nil
+}
diff --git a/pkg/local_object_storage/metabase/metadata.go b/pkg/local_object_storage/metabase/metadata.go
@@ -10,7 +10,6 @@ import (
 	"math/big"
 	"slices"
 	"strconv"
-	"strings"
 
 	"github.com/google/uuid"
 	"github.com/mr-tron/base58"
@@ -49,33 +48,6 @@ func invalidMetaBucketKeyErr(key []byte, cause error) error {
 	return fmt.Errorf("invalid meta bucket key (prefix 0x%X): %w", key[0], cause)
 }
 
-// checks whether given header corresponds to metadata bucket requirements and
-// limits.
-func verifyHeaderForMetadata(hdr object.Object) error {
-	if ln := hdr.HeaderLen(); ln > object.MaxHeaderLen {
-		return fmt.Errorf("header len %d exceeds the limit", ln)
-	}
-	if hdr.GetContainerID().IsZero() {
-		return fmt.Errorf("invalid container: %w", cid.ErrZero)
-	}
-	if hdr.Owner().IsZero() {
-		return fmt.Errorf("invalid owner: %w", user.ErrZeroID)
-	}
-	if _, ok := hdr.PayloadChecksum(); !ok {
-		return errors.New("missing payload checksum")
-	}
-	attrs := hdr.Attributes()
-	for i := range attrs {
-		if strings.IndexByte(attrs[i].Key(), attributeDelimiter[0]) >= 0 {
-			return fmt.Errorf("attribute #%d key contains 0x%02X byte used in sep", i, attributeDelimiter[0])
-		}
-		if strings.IndexByte(attrs[i].Value(), attributeDelimiter[0]) >= 0 {
-			return fmt.Errorf("attribute #%d value contains 0x%02X byte used in sep", i, attributeDelimiter[0])
-		}
-	}
-	return nil
-}
-
 // PutMetadataForObject fills object meta-data indexes using bbolt transaction.
 // Transaction must be writable. Additional bucket for container's meta-data
 // may be created using {255, CID...} form as a key.
@@ -180,21 +152,21 @@ func deleteMetadata(tx *bbolt.Tx, cnr cid.ID, id oid.ID) error {
 	pref[0] = metaPrefixIDAttr
 	c := metaBkt.Cursor()
 	for kIDAttr, _ := c.Seek(pref); bytes.HasPrefix(kIDAttr, pref); kIDAttr, _ = c.Next() {
-		sepInd := bytes.LastIndex(kIDAttr, attributeDelimiter)
+		sepInd := bytes.LastIndex(kIDAttr, objectcore.AttributeDelimiter)
 		if sepInd < 0 {
 			return fmt.Errorf("invalid key with prefix 0x%X in meta bucket: missing delimiter", kIDAttr[0])
 		}
 		kAttrID := make([]byte, len(kIDAttr)+attributeDelimiterLen)
 		kAttrID[0] = metaPrefixAttrIDPlain
 		off := 1 + copy(kAttrID[1:], kIDAttr[1+oid.Size:])
-		off += copy(kAttrID[off:], attributeDelimiter)
+		off += copy(kAttrID[off:], objectcore.AttributeDelimiter)
 		copy(kAttrID[off:], id[:])
 		ks = append(ks, kIDAttr, kAttrID)
 		if n, ok := new(big.Int).SetString(string(kIDAttr[sepInd+attributeDelimiterLen:]), 10); ok && intWithinLimits(n) {
 			kAttrIDInt := make([]byte, sepInd+attributeDelimiterLen+intValLen)
 			kAttrIDInt[0] = metaPrefixAttrIDInt
 			off := 1 + copy(kAttrIDInt[1:], kIDAttr[1+oid.Size:sepInd])
-			off += copy(kAttrIDInt[off:], attributeDelimiter)
+			off += copy(kAttrIDInt[off:], objectcore.AttributeDelimiter)
 			putInt(kAttrIDInt[off:off+intValLen], n)
 			copy(kAttrIDInt[off+intValLen:], id[:])
 			ks = append(ks, kAttrIDInt)
@@ -307,7 +279,7 @@ func PreprocessSearchQuery(fs object.SearchFilters, attrs []string, cursor strin
 			if !bytes.Equal(primKeysPrefix[1:1+len(attrs[0])], []byte(attrs[0])) {
 				return nil, nil, fmt.Errorf("%w: %w", errInvalidCursor, errWrongPrimaryAttribute)
 			}
-			if !bytes.Equal(primKeysPrefix[1+len(attrs[0]):], attributeDelimiter) {
+			if !bytes.Equal(primKeysPrefix[1+len(attrs[0]):], objectcore.AttributeDelimiter) {
 				return nil, nil, fmt.Errorf("%w: %w", errInvalidCursor, errWrongKeyValDelim)
 			}
 			if primSeekKey[len(primKeysPrefix)] > 1 {
@@ -321,10 +293,10 @@ func PreprocessSearchQuery(fs object.SearchFilters, attrs []string, cursor strin
 			if !bytes.Equal(primKeysPrefix[1:1+len(attrs[0])], []byte(attrs[0])) {
 				return nil, nil, fmt.Errorf("%w: %w", errInvalidCursor, errWrongPrimaryAttribute)
 			}
-			if !bytes.Equal(primKeysPrefix[1+len(attrs[0]):], attributeDelimiter) {
+			if !bytes.Equal(primKeysPrefix[1+len(attrs[0]):], objectcore.AttributeDelimiter) {
 				return nil, nil, fmt.Errorf("%w: %w", errInvalidCursor, errWrongKeyValDelim)
 			}
-			if !bytes.Equal(primSeekKey[len(primSeekKey)-oid.Size-attributeDelimiterLen:][:attributeDelimiterLen], attributeDelimiter) {
+			if !bytes.Equal(primSeekKey[len(primSeekKey)-oid.Size-attributeDelimiterLen:][:attributeDelimiterLen], objectcore.AttributeDelimiter) {
 				return nil, nil, fmt.Errorf("%w: %w", errInvalidCursor, errWrongValOIDDelim)
 			}
 		}
@@ -354,15 +326,15 @@ func PreprocessSearchQuery(fs object.SearchFilters, attrs []string, cursor strin
 			if objectcore.IsIntegerSearchOp(primMatcher) {
 				f := fInt[0]
 				if !f.auto && (primMatcher == object.MatchNumGE || primMatcher == object.MatchNumGT) {
-					primSeekKey = slices.Concat([]byte{metaPrefixAttrIDInt}, []byte(attrs[0]), attributeDelimiter, f.b)
+					primSeekKey = slices.Concat([]byte{metaPrefixAttrIDInt}, []byte(attrs[0]), objectcore.AttributeDelimiter, f.b)
 					primKeysPrefix = primSeekKey[:1+len(attrs[0])+attributeDelimiterLen]
 				} else {
-					primSeekKey = slices.Concat([]byte{metaPrefixAttrIDInt}, []byte(attrs[0]), attributeDelimiter)
+					primSeekKey = slices.Concat([]byte{metaPrefixAttrIDInt}, []byte(attrs[0]), objectcore.AttributeDelimiter)
 					primKeysPrefix = primSeekKey
 				}
 			} else {
 				// according to the condition above, primValDB is empty for '!=' matcher as it should be
-				primSeekKey = slices.Concat([]byte{metaPrefixAttrIDPlain}, []byte(attrs[0]), attributeDelimiter, primValDB)
+				primSeekKey = slices.Concat([]byte{metaPrefixAttrIDPlain}, []byte(attrs[0]), objectcore.AttributeDelimiter, primValDB)
 				primKeysPrefix = primSeekKey[:1+len(attrs[0])+attributeDelimiterLen]
 			}
 		}
@@ -377,7 +349,7 @@ func splitValOID(b []byte) ([]byte, []byte, error) {
 	}
 	idOff := len(b) - oid.Size
 	valLn := idOff - attributeDelimiterLen
-	if !bytes.Equal(b[valLn:idOff], attributeDelimiter) {
+	if !bytes.Equal(b[valLn:idOff], objectcore.AttributeDelimiter) {
 		return nil, nil, errWrongValOIDDelim
 	}
 	return b[:valLn], b[idOff:], nil
@@ -800,11 +772,11 @@ func prepareMetaAttrIDKey(buf *keyBuffer, id oid.ID, attr string, valLen int, in
 		k[0] = metaPrefixAttrIDPlain
 	}
 	off := 1 + copy(k[1:], attr)
-	off += copy(k[off:], attributeDelimiter)
+	off += copy(k[off:], objectcore.AttributeDelimiter)
 	valOff := off
 	off += valLen
 	if !intAttr {
-		off += copy(k[off:], attributeDelimiter)
+		off += copy(k[off:], objectcore.AttributeDelimiter)
 	}
 	copy(k[off:], id[:])
 	return k, valOff
@@ -816,7 +788,7 @@ func prepareMetaIDAttrKey(buf *keyBuffer, id oid.ID, attr string, valLen int) []
 	k[0] = metaPrefixIDAttr
 	off := 1 + copy(k[1:], id[:])
 	off += copy(k[off:], attr)
-	copy(k[off:], attributeDelimiter)
+	copy(k[off:], objectcore.AttributeDelimiter)
 	return k
 }
 
@@ -854,7 +826,7 @@ func (x *metaAttributeSeeker) get(id []byte, attr string) ([]byte, error) {
 	pref[0] = metaPrefixIDAttr
 	off := 1 + copy(pref[1:], id)
 	off += copy(pref[off:], attr)
-	copy(pref[off:], attributeDelimiter)
+	copy(pref[off:], objectcore.AttributeDelimiter)
 	if x.crsr == nil {
 		x.crsr = x.bkt.Cursor()
 	}
@@ -916,7 +888,7 @@ func CalculateCursor(fs object.SearchFilters, lastItem client.SearchResultItem)
 			}
 			res := make([]byte, len(attr)+attributeDelimiterLen+intValLen+oid.Size)
 			off := copy(res, attr)
-			off += copy(res[off:], attributeDelimiter)
+			off += copy(res[off:], objectcore.AttributeDelimiter)
 			putInt(res[off:off+intValLen], n)
 			copy(res[off+intValLen:], lastItem.ID[:])
 			return res, nil
@@ -933,12 +905,12 @@ func CalculateCursor(fs object.SearchFilters, lastItem client.SearchResultItem)
 		}
 		res := make([]byte, len(attr)+attributeDelimiterLen+ln+attributeDelimiterLen+oid.Size)
 		off := copy(res, attr)
-		off += copy(res[off:], attributeDelimiter)
+		off += copy(res[off:], objectcore.AttributeDelimiter)
 		var err error
 		if _, err = hex.Decode(res[off:], []byte(lastItemVal)); err != nil {
 			return nil, fmt.Errorf("decode %q attribute from HEX: %w", attr, err)
 		}
-		off += copy(res[off+ln:], attributeDelimiter)
+		off += copy(res[off+ln:], objectcore.AttributeDelimiter)
 		copy(res[off:], lastItem.ID[:])
 		return res, nil
 	case object.FilterSplitID:
@@ -955,9 +927,9 @@ func CalculateCursor(fs object.SearchFilters, lastItem client.SearchResultItem)
 	kln := len(attr) + attributeDelimiterLen + len(val) + attributeDelimiterLen + oid.Size
 	res := make([]byte, kln)
 	off := copy(res, attr)
-	off += copy(res[off:], attributeDelimiter)
+	off += copy(res[off:], objectcore.AttributeDelimiter)
 	off += copy(res[off:], val)
-	off += copy(res[off:], attributeDelimiter)
+	off += copy(res[off:], objectcore.AttributeDelimiter)
 	copy(res[off:], lastItem.ID[:])
 	return res, nil
 }
diff --git a/pkg/local_object_storage/metabase/put.go b/pkg/local_object_storage/metabase/put.go
@@ -64,7 +64,7 @@ func (db *DB) Put(obj *objectSDK.Object, storageID []byte, binHeader []byte) err
 func (db *DB) put(
 	tx *bbolt.Tx, obj *objectSDK.Object, id []byte,
 	si *objectSDK.SplitInfo, currEpoch uint64, hdrBin []byte) error {
-	if err := verifyHeaderForMetadata(*obj); err != nil {
+	if err := objectCore.VerifyHeaderForMetadata(*obj); err != nil {
 		return err
 	}
 
diff --git a/pkg/local_object_storage/metabase/util.go b/pkg/local_object_storage/metabase/util.go
@@ -12,9 +12,6 @@ import (
 	"go.etcd.io/bbolt"
 )
 
-// object attribute key and value separator used in DB.
-var attributeDelimiter = []byte{0x00}
-
 const attributeDelimiterLen = 1
 
 var (
diff --git a/pkg/local_object_storage/metabase/util_test.go b/pkg/local_object_storage/metabase/util_test.go
@@ -3,6 +3,7 @@ package meta
 import (
 	"testing"
 
+	"github.com/nspcc-dev/neofs-node/pkg/core/object"
 	cid "github.com/nspcc-dev/neofs-sdk-go/container/id"
 	"github.com/stretchr/testify/require"
 )
@@ -15,7 +16,7 @@ type mockContainers struct {
 func (x mockContainers) Exists(cid.ID) (bool, error) { return !x.absent, x.err }
 
 func TestAttributeDelimiter(t *testing.T) {
-	t.Run("len", func(t *testing.T) { require.Len(t, attributeDelimiter, attributeDelimiterLen) })
+	t.Run("len", func(t *testing.T) { require.Len(t, object.AttributeDelimiter, attributeDelimiterLen) })
 }
 
 func TestKeyBuffer(t *testing.T) {
diff --git a/pkg/local_object_storage/metabase/version.go b/pkg/local_object_storage/metabase/version.go
@@ -9,6 +9,7 @@ import (
 	"slices"
 
 	objectconfig "github.com/nspcc-dev/neofs-node/cmd/neofs-node/config/object"
+	objectcore "github.com/nspcc-dev/neofs-node/pkg/core/object"
 	"github.com/nspcc-dev/neofs-node/pkg/local_object_storage/util/logicerr"
 	cid "github.com/nspcc-dev/neofs-sdk-go/container/id"
 	"github.com/nspcc-dev/neofs-sdk-go/object"
@@ -224,7 +225,7 @@ func migrateObjectToMetaBucket(l *zap.Logger, tx *bbolt.Tx, metaBkt *bbolt.Bucke
 			zap.Stringer("container", cnr), zap.Stringer("object", oid.ID(id)), zap.Binary("data", bin))
 		return false, nil
 	}
-	if err := verifyHeaderForMetadata(hdr); err != nil {
+	if err := objectcore.VerifyHeaderForMetadata(hdr); err != nil {
 		l.Info("invalid header in the container bucket, ignoring", zap.Error(err),
 			zap.Stringer("container", cnr), zap.Stringer("object", oid.ID(id)), zap.Binary("data", bin))
 		return false, nil
@@ -242,7 +243,7 @@ func migrateObjectToMetaBucket(l *zap.Logger, tx *bbolt.Tx, metaBkt *bbolt.Bucke
 		return false, fmt.Errorf("put metadata for object %s: %w", oid.ID(id), err)
 	}
 	if hasParent && !par.GetID().IsZero() { // skip the first object without useful info similar to DB.put
-		if err := verifyHeaderForMetadata(hdr); err != nil {
+		if err := objectcore.VerifyHeaderForMetadata(hdr); err != nil {
 			l.Info("invalid parent header in the container bucket, ignoring", zap.Error(err),
 				zap.Stringer("container", cnr), zap.Stringer("child", oid.ID(id)),
 				zap.Stringer("parent", par.GetID()), zap.Binary("data", bin))
diff --git a/pkg/services/meta/containers.go b/pkg/services/meta/containers.go

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ func (db DB) Put(obj objectSDK.Object, storageID []byte, binHeader []byte) err`
`64`	`64`	`func (db *DB) put(`
`65`	`65`	`tx bbolt.Tx, obj objectSDK.Object, id []byte,`
`66`	`66`	`si *objectSDK.SplitInfo, currEpoch uint64, hdrBin []byte) error {`
`67`		`- if err := verifyHeaderForMetadata(*obj); err != nil {`
	`67`	`+ if err := objectCore.VerifyHeaderForMetadata(*obj); err != nil {`
`68`	`68`	`return err`
`69`	`69`	`}`
`70`	`70`
Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,6 @@ import (`
`12`	`12`	`"go.etcd.io/bbolt"`
`13`	`13`	`)`
`14`	`14`
`15`		`-// object attribute key and value separator used in DB.`
`16`		`-var attributeDelimiter = []byte{0x00}`
`17`		`-`
`18`	`15`	`const attributeDelimiterLen = 1`
`19`	`16`
`20`	`17`	`var (`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package meta`
`3`	`3`	`import (`
`4`	`4`	`"testing"`
`5`	`5`
	`6`	`+ "github.com/nspcc-dev/neofs-node/pkg/core/object"`
`6`	`7`	`cid "github.com/nspcc-dev/neofs-sdk-go/container/id"`
`7`	`8`	`"github.com/stretchr/testify/require"`
`8`	`9`	`)`
`@@ -15,7 +16,7 @@ type mockContainers struct {`
`15`	`16`	`func (x mockContainers) Exists(cid.ID) (bool, error) { return !x.absent, x.err }`
`16`	`17`
`17`	`18`	`func TestAttributeDelimiter(t *testing.T) {`
`18`		`- t.Run("len", func(t *testing.T) { require.Len(t, attributeDelimiter, attributeDelimiterLen) })`
	`19`	`+ t.Run("len", func(t *testing.T) { require.Len(t, object.AttributeDelimiter, attributeDelimiterLen) })`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`func TestKeyBuffer(t *testing.T) {`