Fix JSON serde, refactored encoding tests, fix some documentation (#62)

* Fix JSON serde, refactored encoding tests, fix some documentation

Signed-off-by: bytemare <3641580+bytemare@users.noreply.github.com>

---------

Signed-off-by: bytemare <3641580+bytemare@users.noreply.github.com>

.github/.golangci.yml

@@ -13,17 +13,17 @@ linters:
     - dogsled
     - dupl
     - durationcheck
+    - err113
     - errcheck
     - errchkjson
     - errname
     - errorlint
-    - execinquery
     #- exhaustive
     #- exhaustruct
     - exportloopref
     - forbidigo
     - forcetypeassert
-    - funlen
+    #- funlencd
     - gci
     #- gochecknoglobals
     #- gochecknoinits
@@ -33,7 +33,6 @@ linters:
     - gocyclo
     - godot
     - godox
-    - goerr113
     - gofmt
     - gofumpt
     - goheader
@@ -51,7 +50,7 @@ linters:
     #- interfacebloat
     #- ireturn
     - lll
-    - logrlint
+    - loggercheck
     - maintidx
     - makezero
     - misspell
@@ -101,7 +100,9 @@ linters-settings:
   errcheck:
     check-type-assertions: true
     check-blank: true
-    #exclude-functions:
+    exclude-functions:
+      - (*crypto/Element).MarshalBinary
+      - (*crypto/Scalar).MarshalBinary
     #  - io/ioutil.ReadFile
     #  - io.Copy(*bytes.Buffer)
     #  - io.Copy(os.Stdout)
@@ -145,16 +146,6 @@ linters-settings:
     simplify: true
   goimports:
     local-prefixes: github.com/bytemare/crypto
-  gomnd:
-    checks:
-      - argument
-      - condition
-      - return
-      - assign
-    ignored-functions:
-      - 'nist.setMapping'
-      - 'big.NewInt'
-      - 'hash2curve.HashToFieldXMD'
   gosimple:
     checks: [ "all" ]
   govet:
@@ -203,6 +194,16 @@ linters-settings:
     tab-width: 4
   misspell:
     locale: US
+  mnd:
+    checks:
+      - argument
+      - condition
+      - return
+      - assign
+    ignored-functions:
+      - 'nist.setMapping'
+      - 'big.NewInt'
+      - 'hash2curve.HashToFieldXMD'
   nlreturn:
     block-size: 2
   prealloc:

element.go

@@ -11,6 +11,7 @@ package crypto
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/bytemare/crypto/internal"
 )
@@ -148,27 +149,23 @@ func (e *Element) DecodeHex(h string) error {
 
 // MarshalJSON marshals the element into valid JSON.
 func (e *Element) MarshalJSON() ([]byte, error) {
-	return []byte(e.Hex()), nil
+	return []byte(fmt.Sprintf("%q", e.Hex())), nil
 }
 
 // UnmarshalJSON unmarshals the input into the element.
 func (e *Element) UnmarshalJSON(data []byte) error {
-	return e.DecodeHex(string(data))
+	j := strings.ReplaceAll(string(data), "\"", "")
+	return e.DecodeHex(j)
 }
 
 // MarshalBinary returns the compressed byte encoding of the element.
 func (e *Element) MarshalBinary() ([]byte, error) {
-	dec, err := e.Element.MarshalBinary()
-	if err != nil {
-		return nil, fmt.Errorf("element MarshalBinary: %w", err)
-	}
-
-	return dec, nil
+	return e.Element.Encode(), nil
 }
 
 // UnmarshalBinary sets e to the decoding of the byte encoded element.
 func (e *Element) UnmarshalBinary(data []byte) error {
-	if err := e.Element.UnmarshalBinary(data); err != nil {
+	if err := e.Element.Decode(data); err != nil {
 		return fmt.Errorf("element UnmarshalBinary: %w", err)
 	}
 

groups.go

@@ -163,8 +163,6 @@ func (g Group) init() {
 	switch g {
 	case Ristretto255Sha512:
 		g.initGroup(ristretto.New)
-	case decaf448Shake256:
-		panic("decaf is not yet supported")
 	case P256Sha256:
 		g.initGroup(nist.P256)
 	case P384Sha384:
@@ -175,8 +173,6 @@ func (g Group) init() {
 		g.initGroup(edwards25519.New)
 	case Secp256k1:
 		g.initGroup(secp256k1.New)
-	case maxID:
-		panic("group not recognized")
 	default:
 		panic("group not recognized")
 	}

internal/edwards25519/element.go

@@ -178,13 +178,3 @@ func (e *Element) DecodeHex(h string) error {
 
 	return e.Decode(b)
 }
-
-// MarshalBinary returns the compressed byte encoding of the element.
-func (e *Element) MarshalBinary() (data []byte, err error) {
-	return e.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded element.
-func (e *Element) UnmarshalBinary(data []byte) error {
-	return e.Decode(data)
-}

internal/edwards25519/scalar.go

@@ -360,17 +360,3 @@ func (s *Scalar) DecodeHex(h string) error {
 
 	return s.Decode(b)
 }
-
-// MarshalBinary returns the compressed byte encoding of the scalar.
-func (s *Scalar) MarshalBinary() (data []byte, err error) {
-	return s.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded scalar.
-func (s *Scalar) UnmarshalBinary(data []byte) error {
-	if err := s.Decode(data); err != nil {
-		return fmt.Errorf("edwards25519: %w", err)
-	}
-
-	return nil
-}

internal/element.go

@@ -9,10 +9,6 @@
 // Package internal defines simple and abstract APIs to group Elements and Scalars.
 package internal
 
-import (
-	"encoding"
-)
-
 // Element interface abstracts common operations on an Element in a prime-order Group.
 type Element interface {
 	// Base sets the element to the group's base point a.k.a. canonical generator.
@@ -62,10 +58,4 @@ type Element interface {
 
 	// DecodeHex sets e to the decoding of the hex encoded element.
 	DecodeHex(h string) error
-
-	// BinaryMarshaler implementation.
-	encoding.BinaryMarshaler
-
-	// BinaryUnmarshaler implementation.
-	encoding.BinaryUnmarshaler
 }

internal/nist/element.go

@@ -235,13 +235,3 @@ func (e *Element[P]) DecodeHex(h string) error {
 
 	return e.Decode(b)
 }
-
-// MarshalBinary returns the compressed byte encoding of the element.
-func (e *Element[P]) MarshalBinary() ([]byte, error) {
-	return e.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded element.
-func (e *Element[P]) UnmarshalBinary(data []byte) error {
-	return e.Decode(data)
-}

internal/nist/scalar.go

@@ -265,17 +265,3 @@ func (s *Scalar) DecodeHex(h string) error {
 
 	return s.Decode(b)
 }
-
-// MarshalBinary returns the compressed byte encoding of the scalar.
-func (s *Scalar) MarshalBinary() ([]byte, error) {
-	return s.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded scalar.
-func (s *Scalar) UnmarshalBinary(data []byte) error {
-	if err := s.Decode(data); err != nil {
-		return fmt.Errorf("nist: %w", err)
-	}
-
-	return nil
-}

internal/ristretto/element.go

@@ -184,13 +184,3 @@ func (e *Element) DecodeHex(h string) error {
 
 	return e.Decode(b)
 }
-
-// MarshalBinary returns the compressed byte encoding of the element.
-func (e *Element) MarshalBinary() ([]byte, error) {
-	return e.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded element.
-func (e *Element) UnmarshalBinary(data []byte) error {
-	return e.Decode(data)
-}

internal/ristretto/scalar.go

@@ -350,17 +350,3 @@ func (s *Scalar) DecodeHex(h string) error {
 
 	return s.Decode(b)
 }
-
-// MarshalBinary returns the compressed byte encoding of the scalar.
-func (s *Scalar) MarshalBinary() ([]byte, error) {
-	return s.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded scalar.
-func (s *Scalar) UnmarshalBinary(data []byte) error {
-	if err := s.Decode(data); err != nil {
-		return fmt.Errorf("ristretto: %w", err)
-	}
-
-	return nil
-}

internal/scalar.go

@@ -9,10 +9,6 @@
 // Package internal defines simple and abstract APIs to group Elements and Scalars.
 package internal
 
-import (
-	"encoding"
-)
-
 // Scalar interface abstracts common operations on scalars in a prime-order Group.
 type Scalar interface {
 	// Zero sets the scalar to 0, and returns it.
@@ -73,11 +69,4 @@ type Scalar interface {
 
 	// DecodeHex sets s to the decoding of the hex encoded scalar.
 	DecodeHex(h string) error
-
-	// BinaryMarshaler returns a byte representation of the element.
-	encoding.BinaryMarshaler
-
-	// BinaryUnmarshaler recovers an element from a byte representation
-	// produced either by encoding.BinaryMarshaler or MarshalBinaryCompress.
-	encoding.BinaryUnmarshaler
 }

internal/secp256k1/element.go

@@ -149,13 +149,3 @@ func (e *Element) DecodeHex(h string) error {
 
 	return e.Decode(b)
 }
-
-// MarshalBinary returns the compressed byte encoding of the element.
-func (e *Element) MarshalBinary() (data []byte, err error) {
-	return e.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded element.
-func (e *Element) UnmarshalBinary(data []byte) error {
-	return e.Decode(data)
-}

internal/secp256k1/scalar.go

@@ -205,13 +205,3 @@ func (s *Scalar) DecodeHex(h string) error {
 
 	return nil
 }
-
-// MarshalBinary returns the compressed byte encoding of the scalar.
-func (s *Scalar) MarshalBinary() (data []byte, err error) {
-	return s.Encode(), nil
-}
-
-// UnmarshalBinary sets e to the decoding of the byte encoded scalar.
-func (s *Scalar) UnmarshalBinary(data []byte) error {
-	return s.Decode(data)
-}

scalar.go

@@ -11,6 +11,7 @@ package crypto
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/bytemare/crypto/internal"
 )
@@ -180,27 +181,23 @@ func (s *Scalar) DecodeHex(h string) error {
 
 // MarshalJSON marshals the scalar into valid JSON.
 func (s *Scalar) MarshalJSON() ([]byte, error) {
-	return []byte(s.Hex()), nil
+	return []byte(fmt.Sprintf("%q", s.Hex())), nil
 }
 
 // UnmarshalJSON unmarshals the input into the scalar.
 func (s *Scalar) UnmarshalJSON(data []byte) error {
-	return s.DecodeHex(string(data))
+	j := strings.ReplaceAll(string(data), "\"", "")
+	return s.DecodeHex(j)
 }
 
 // MarshalBinary implements the encoding.BinaryMarshaler interface.
 func (s *Scalar) MarshalBinary() ([]byte, error) {
-	dec, err := s.Scalar.MarshalBinary()
-	if err != nil {
-		return nil, fmt.Errorf("scalar MarshalBinary: %w", err)
-	}
-
-	return dec, nil
+	return s.Scalar.Encode(), nil
 }
 
 // UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
 func (s *Scalar) UnmarshalBinary(data []byte) error {
-	if err := s.Scalar.UnmarshalBinary(data); err != nil {
+	if err := s.Scalar.Decode(data); err != nil {
 		return fmt.Errorf("scalar UnmarshalBinary: %w", err)
 	}