Performant validation. Prevent redundant decoding. Remove unused errors.

This commit is contained in:
Jay
2026-04-20 22:59:48 -04:00
parent 62aeef4eaf
commit 747781f5bf
4 changed files with 57 additions and 42 deletions
-3
View File
@@ -20,9 +20,6 @@ var (
// MalformedTag indicates an event tag contains fewer than two elements. // MalformedTag indicates an event tag contains fewer than two elements.
MalformedTag = errors.New("tags must contain at least two elements") MalformedTag = errors.New("tags must contain at least two elements")
// NoEventID indicates the event ID field is empty.
NoEventID = errors.New("event id is empty")
// InvalidSig indicates the event signature failed cryptographic validation. // InvalidSig indicates the event signature failed cryptographic validation.
InvalidSig = errors.New("event signature is invalid") InvalidSig = errors.New("event signature is invalid")
) )
-14
View File
@@ -3,10 +3,6 @@
// serialization, cryptographic signatures, and subscription filters. // serialization, cryptographic signatures, and subscription filters.
package events package events
import (
"regexp"
)
// Tag represents a single tag within an event as an array of strings. // Tag represents a single tag within an event as an array of strings.
// The first element identifies the tag name, the second contains the value, // The first element identifies the tag name, the second contains the value,
// and subsequent elements are optional. // and subsequent elements are optional.
@@ -23,13 +19,3 @@ type Event struct {
Content string `json:"content"` Content string `json:"content"`
Sig string `json:"sig"` Sig string `json:"sig"`
} }
var (
// Hex64Pattern matches 64-character, lowercase, hexadecimal strings.
// Used for validating event IDs and cryptographic keys.
Hex64Pattern = regexp.MustCompile("^[a-f0-9]{64}$")
// Hex128Pattern matches 128-character, lowercase, hexadecimal strings.
// Used for validating signatures.
Hex128Pattern = regexp.MustCompile("^[a-f0-9]{128}$")
)
+12 -8
View File
@@ -6,6 +6,18 @@ import (
"strconv" "strconv"
) )
// GetID computes and returns the event ID as a lowercase, hex-encoded SHA-256 hash
// of the serialized event.
func GetID(e Event) string {
hash := GetIDBytes(e)
return hex.EncodeToString(hash[:])
}
// GetIDBytes computes and returns the event ID as a raw SHA256 digest
func GetIDBytes(e Event) [32]byte {
return sha256.Sum256(Serialize(e))
}
// Serialize returns the canonical JSON array representation of the event. // Serialize returns the canonical JSON array representation of the event.
// used for ID computation: [0, pubkey, created_at, kind, tags, content]. // used for ID computation: [0, pubkey, created_at, kind, tags, content].
func Serialize(e Event) []byte { func Serialize(e Event) []byte {
@@ -13,14 +25,6 @@ func Serialize(e Event) []byte {
return appendSerialized(buf, e) return appendSerialized(buf, e)
} }
// GetID computes and returns the event ID as a lowercase, hex-encoded SHA-256 hash
// of the serialized event.
func GetID(e Event) string {
bytes := Serialize(e)
hash := sha256.Sum256(bytes)
return hex.EncodeToString(hash[:])
}
func appendSerialized(dst []byte, e Event) []byte { func appendSerialized(dst []byte, e Event) []byte {
dst = append(dst, "[0,\""...) dst = append(dst, "[0,\""...)
dst = append(dst, e.PubKey...) dst = append(dst, e.PubKey...)
+45 -17
View File
@@ -1,6 +1,7 @@
package events package events
import ( import (
"bytes"
"encoding/hex" "encoding/hex"
"fmt" "fmt"
"git.wisehodl.dev/jay/go-roots/errors" "git.wisehodl.dev/jay/go-roots/errors"
@@ -14,25 +15,26 @@ func Validate(e Event) error {
return err return err
} }
if err := ValidateID(e); err != nil { idBytes, err := checkIDMatch(e)
if err != nil {
return err return err
} }
return ValidateSignature(e) return validateSignatureBytes(idBytes, e.Sig, e.PubKey)
} }
// ValidateStructure checks that all event fields conform to the protocol // ValidateStructure checks that all event fields conform to the protocol
// specification: hex lengths, tag structure, and field formats. // specification: hex lengths, tag structure, and field formats.
func ValidateStructure(e Event) error { func ValidateStructure(e Event) error {
if !Hex64Pattern.MatchString(e.PubKey) { if !isLowerHex(e.PubKey, 64) {
return errors.MalformedPubKey return errors.MalformedPubKey
} }
if !Hex64Pattern.MatchString(e.ID) { if !isLowerHex(e.ID, 64) {
return errors.MalformedID return errors.MalformedID
} }
if !Hex128Pattern.MatchString(e.Sig) { if !isLowerHex(e.Sig, 128) {
return errors.MalformedSig return errors.MalformedSig
} }
@@ -47,14 +49,8 @@ func ValidateStructure(e Event) error {
// ValidateID recomputes the event ID and verifies it matches the stored ID field. // ValidateID recomputes the event ID and verifies it matches the stored ID field.
func ValidateID(e Event) error { func ValidateID(e Event) error {
computedID := GetID(e) _, err := checkIDMatch(e)
if e.ID == "" { return err
return errors.NoEventID
}
if computedID != e.ID {
return fmt.Errorf("event id %q does not match computed id %q", e.ID, computedID)
}
return nil
} }
// ValidateSignature verifies the event signature is cryptographically valid // ValidateSignature verifies the event signature is cryptographically valid
@@ -64,13 +60,32 @@ func ValidateSignature(e Event) error {
if err != nil { if err != nil {
return fmt.Errorf("invalid event id hex: %w", err) return fmt.Errorf("invalid event id hex: %w", err)
} }
return validateSignatureBytes(idBytes, e.Sig, e.PubKey)
}
sigBytes, err := hex.DecodeString(e.Sig) // Helpers
func checkIDMatch(e Event) ([]byte, error) {
idHash := GetIDBytes(e)
idBytes, err := hex.DecodeString(e.ID)
if err != nil {
return nil, errors.MalformedID
}
if !bytes.Equal(idBytes, idHash[:]) {
return nil, fmt.Errorf(
"event id %q does not match computed id %q",
e.ID, hex.EncodeToString(idHash[:]))
}
return idBytes, nil
}
func validateSignatureBytes(idBytes []byte, sigHex, pkHex string) error {
sigBytes, err := hex.DecodeString(sigHex)
if err != nil { if err != nil {
return fmt.Errorf("invalid event signature hex: %w", err) return fmt.Errorf("invalid event signature hex: %w", err)
} }
pkBytes, err := hex.DecodeString(e.PubKey) pkBytes, err := hex.DecodeString(pkHex)
if err != nil { if err != nil {
return fmt.Errorf("invalid public key hex: %w", err) return fmt.Errorf("invalid public key hex: %w", err)
} }
@@ -87,7 +102,20 @@ func ValidateSignature(e Event) error {
if signature.Verify(idBytes, publicKey) { if signature.Verify(idBytes, publicKey) {
return nil return nil
} else {
return errors.InvalidSig
} }
return errors.InvalidSig
}
func isLowerHex(s string, n int) bool {
if len(s) != n {
return false
}
for i := 0; i < n; i++ {
c := s[i]
if (c < '0' || c > '9') && (c < 'a' || c > 'f') {
return false
}
}
return true
} }