Merge pull request #539 from dedis/idiomatic-package-name

Rename var_ed25519 to more idiomatic go name
dedis · Aug 6, 2024 · b172e02 · b172e02
2 parents f907bcc + 54563c3
commit b172e02
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 21 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -276,11 +276,6 @@ issues:
     - path: "group/edwards25519/scalar.go"
       linters:
         - ineffassign
-    - path: "pairing|group"
-      linters:
-        - revive
-        - stylecheck
-      text: "var-naming: don't use an underscore in package name|ST1003: should not use underscores in package names"
     - path: "pairing/(circl_bls12381|bn254)/."
       linters:
         - errcheck #TODO: proper error handling

diff --git a/encrypt/ecies/ecies_test.go b/encrypt/ecies/ecies_test.go
@@ -7,8 +7,8 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.dedis.ch/kyber/v4"
 	"go.dedis.ch/kyber/v4/group/edwards25519"
+	"go.dedis.ch/kyber/v4/group/edwards25519vartime"
 	"go.dedis.ch/kyber/v4/group/p256"
-	"go.dedis.ch/kyber/v4/group/var_ed25519"
 	"go.dedis.ch/kyber/v4/util/random"
 )
 
@@ -54,8 +54,8 @@ func BenchmarkECIES(b *testing.B) {
 		kyber.Group
 	}{
 		{edwards25519.NewBlakeSHA256Ed25519()},
-		{var_ed25519.NewBlakeSHA256Ed25519(false)},
-		{var_ed25519.NewBlakeSHA256Ed25519(true)},
+		{edwards25519vartime.NewBlakeSHA256Ed25519(false)},
+		{edwards25519vartime.NewBlakeSHA256Ed25519(true)},
 		{p256.NewBlakeSHA256P256()},
 		{p256.NewBlakeSHA256QR512()},
 	}

diff --git a/group/var_ed25519/basic.go → group/edwards25519vartime/basic.go b/group/var_ed25519/basic.go → group/edwards25519vartime/basic.go
@@ -1,7 +1,7 @@
 //go:build experimental
 // +build experimental
 
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"crypto/cipher"

diff --git a/group/var_ed25519/basic_test.go → group/edwards25519vartime/basic_test.go b/group/var_ed25519/basic_test.go → group/edwards25519vartime/basic_test.go
@@ -1,7 +1,7 @@
 //go:build experimental
 // +build experimental
 
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"testing"

diff --git a/group/var_ed25519/curve.go → group/edwards25519vartime/curve.go b/group/var_ed25519/curve.go → group/edwards25519vartime/curve.go
@@ -1,4 +1,4 @@
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"crypto/cipher"

diff --git a/group/var_ed25519/curve_test.go → group/edwards25519vartime/curve_test.go b/group/var_ed25519/curve_test.go → group/edwards25519vartime/curve_test.go
@@ -1,4 +1,4 @@
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"testing"

diff --git a/group/var_ed25519/ext.go → group/edwards25519vartime/ext.go b/group/var_ed25519/ext.go → group/edwards25519vartime/ext.go
@@ -1,4 +1,4 @@
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"crypto/cipher"

diff --git a/group/var_ed25519/param.go → group/edwards25519vartime/param.go b/group/var_ed25519/param.go → group/edwards25519vartime/param.go
@@ -1,4 +1,4 @@
-// Package var_ed25519 contains several implementations of Twisted Edwards Curves,
+// Package edwards25519vartime contains several implementations of Twisted Edwards Curves,
 // from general and unoptimized to highly specialized and optimized.
 //
 // Twisted Edwards curves are elliptic curves satisfying the equation:
@@ -10,7 +10,7 @@
 // are isomorphic to curves having c == 1.
 //
 // For details see Bernstein et al, "Twisted Edwards Curves", http://eprint.iacr.org/2008/013.pdf
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"math/big"
@@ -74,7 +74,7 @@ func Param1174() *Param {
 func ParamEd25519() *Param {
 	var p Param
 	var qs big.Int
-	p.Name = "var_ed25519"
+	p.Name = "edwards25519vartime"
 	p.P.SetBit(zero, 255, 1).Sub(&p.P, big.NewInt(19))
 	qs.SetString("27742317777372353535851937790883648493", 10)
 	p.Q.SetBit(zero, 252, 1).Add(&p.Q, &qs)

diff --git a/group/var_ed25519/proj.go → group/edwards25519vartime/proj.go b/group/var_ed25519/proj.go → group/edwards25519vartime/proj.go
@@ -1,4 +1,4 @@
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"crypto/cipher"

diff --git a/group/var_ed25519/suite.go → group/edwards25519vartime/suite.go b/group/var_ed25519/suite.go → group/edwards25519vartime/suite.go
@@ -1,4 +1,4 @@
-package var_ed25519
+package edwards25519vartime
 
 import (
 	"crypto/cipher"

diff --git a/proof/proof_test.go b/proof/proof_test.go
@@ -8,8 +8,8 @@ import (
 
 	"go.dedis.ch/kyber/v4"
 	"go.dedis.ch/kyber/v4/group/edwards25519"
+	"go.dedis.ch/kyber/v4/group/edwards25519vartime"
 	"go.dedis.ch/kyber/v4/group/p256"
-	"go.dedis.ch/kyber/v4/group/var_ed25519"
 	"go.dedis.ch/kyber/v4/xof/blake2xb"
 )
 
@@ -256,8 +256,8 @@ func BenchmarkProof(b *testing.B) {
 		Suite
 	}{
 		{edwards25519.NewBlakeSHA256Ed25519()},
-		{var_ed25519.NewBlakeSHA256Ed25519(false)},
-		{var_ed25519.NewBlakeSHA256Ed25519(true)},
+		{edwards25519vartime.NewBlakeSHA256Ed25519(false)},
+		{edwards25519vartime.NewBlakeSHA256Ed25519(true)},
 		{p256.NewBlakeSHA256P256()},
 		{p256.NewBlakeSHA256QR512()},
 	}