Merge pull request #7 from FishGoddess/develop

增加 ED25519 算法的支持

Author: FishGoddess

.gitignore

@@ -16,4 +16,6 @@ target/
 bin/
 *.test
 *.out
-*.log
+*.log
+*.key
+*.pub

FUTURE.md

@@ -9,8 +9,8 @@
 
 ### v0.5.x
 
-* [ ] 支持 ECDSA 算法
-* [ ] 支持 EdDSA 算法
+* [ ] 支持 X25519 算法
+* [x] 支持 ED25519 算法
 * [x] 重构代码，优化使用方式
 * [ ] 提升覆盖率到 90% 以上
 

HISTORY.md

@@ -1,5 +1,11 @@
 ## 📜 历史版本的特性介绍 (Features in old versions)
 
+### v0.5.1-alpha
+
+> 此版本发布于 2025-12-07
+
+* 增加 ED25519 算法的支持
+
 ### v0.5.0-alpha
 
 > 此版本发布于 2025-12-05

Makefile

@@ -16,3 +16,5 @@ bench:
 	go test -v ./_examples/aes_test.go -bench=. -benchtime=1s
 	go test -v ./_examples/rsa_test.go -bench=. -benchtime=1s
 	go test -v ./_examples/rsa_key_test.go -bench=. -benchtime=1s
+	go test -v ./_examples/ed25519_test.go -bench=. -benchtime=1s
+	go test -v ./_examples/ed25519_key_test.go -bench=. -benchtime=1s

README.en.md

@@ -17,6 +17,7 @@
 * HMAC mixed hash supports.
 * DES/3DES/AES encrypt and decrypt supports.
 * RSA encrypt and decrypt supports.
+* ED25519 sign supports.
 * ECB/CBC/OFB/CFB/CTR/GCM mode supports.
 * ZERO/PKCS5/PKCS7 padding supports.
 
@@ -35,6 +36,8 @@ $ go get -u github.com/FishGoddess/cryptox
 * [aes](_examples/aes.go)
 * [rsa](_examples/rsa.go)
 * [rsa_key](_examples/rsa_key.go)
+* [ed25519](_examples/ed25519.go)
+* [ed25519_key](_examples/ed25519_key.go)
 
 ### 🚴🏻 Benchmarks
 
@@ -120,6 +123,11 @@ BenchmarkRSA_VerifyPSS-2                           20220             56627 ns/op
 BenchmarkRSA_GenerateKeys1024-2               60          21398224 ns/op          283350 B/op       2851 allocs/op
 BenchmarkRSA_GenerateKeys2048-2               84         117753488 ns/op          600303 B/op       5459 allocs/op
 BenchmarkRSA_GenerateKeys4096-2                1        1432974432 ns/op         2709912 B/op      14359 allocs/op
+
+BenchmarkED25519_Sign-2            32125             36469 ns/op             112 B/op          2 allocs/op
+BenchmarkED25519_Verify-2          13927             90989 ns/op              48 B/op          1 allocs/op
+
+BenchmarkED25519_GenerateKeys-2            38296             30692 ns/op             208 B/op          4 allocs/op
 ```
 
 ### 🎨 Contributing

README.md

@@ -17,6 +17,7 @@
 * 支持 HMAC 混合基础的散列算法。
 * 支持 DES/3DES/AES 等对称加密算法。
 * 支持 RSA 等非对称加密算法。
+* 支持 ED25519 等签名算法。
 * 支持 ECB/CBC/OFB/CFB/CTR/GCM 等分组模式。
 * 支持 ZERO/PKCS5/PKCS7 等字节填充方式。
 
@@ -35,6 +36,8 @@ $ go get -u github.com/FishGoddess/cryptox
 * [aes](_examples/aes.go)
 * [rsa](_examples/rsa.go)
 * [rsa_key](_examples/rsa_key.go)
+* [ed25519](_examples/ed25519.go)
+* [ed25519_key](_examples/ed25519_key.go)
 
 ### 🚴🏻 性能测试
 
@@ -120,6 +123,11 @@ BenchmarkRSA_VerifyPSS-2                           20220             56627 ns/op
 BenchmarkRSA_GenerateKeys1024-2               60          21398224 ns/op          283350 B/op       2851 allocs/op
 BenchmarkRSA_GenerateKeys2048-2               84         117753488 ns/op          600303 B/op       5459 allocs/op
 BenchmarkRSA_GenerateKeys4096-2                1        1432974432 ns/op         2709912 B/op      14359 allocs/op
+
+BenchmarkED25519_Sign-2            32125             36469 ns/op             112 B/op          2 allocs/op
+BenchmarkED25519_Verify-2          13927             90989 ns/op              48 B/op          1 allocs/op
+
+BenchmarkED25519_GenerateKeys-2            38296             30692 ns/op             208 B/op          4 allocs/op
 ```
 
 ### 🎨 贡献者

_examples/ed25519.go

@@ -0,0 +1,40 @@
+// Copyright 2025 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	"fmt"
+
+	"github.com/FishGoddess/cryptox/ed25519"
+)
+
+func main() {
+	// Load the private key and the public key from file.
+	// Check ed25519.Option for more information about file encoding.
+	privateKey, err := ed25519.LoadPrivateKey("ed25519.key")
+	if err != nil {
+		panic(err)
+	}
+
+	publicKey, err := ed25519.LoadPublicKey("ed25519.pub")
+	if err != nil {
+		panic(err)
+	}
+
+	data := []byte("戴上头箍，爱不了你；不戴头箍，救不了你。")
+	fmt.Printf("data: %s\n", data)
+
+	// Use the private key to sign data.
+	sign := privateKey.Sign(data, ed25519.WithHex())
+	fmt.Printf("sign: %s\n", sign)
+
+	// Use the public key to verify the sign.
+	err = publicKey.Verify(data, sign, ed25519.WithHex())
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("verify: %s\n", data)
+}

_examples/ed25519_key.go

@@ -0,0 +1,47 @@
+// Copyright 2025 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	"github.com/FishGoddess/cryptox/ed25519"
+)
+
+func main() {
+	// Generate a key without seed.
+	privateKey, publicKey, err := ed25519.GenerateKeys()
+	if err != nil {
+		panic(err)
+	}
+
+	// Generate a key with seed.
+	seed := []byte("12345678876543211234567887654321")
+
+	privateKey, publicKey, err = ed25519.GenerateKeys(ed25519.WithKeySeed(seed))
+	if err != nil {
+		panic(err)
+	}
+
+	// Store the private key and the public key to file.
+	err = ed25519.StorePrivateKey("ed25519.key", privateKey)
+	if err != nil {
+		panic(err)
+	}
+
+	err = ed25519.StorePublicKey("ed25519.pub", publicKey)
+	if err != nil {
+		panic(err)
+	}
+
+	// Load the private key and the public key from file.
+	privateKey, err = ed25519.LoadPrivateKey("ed25519.key")
+	if err != nil {
+		panic(err)
+	}
+
+	publicKey, err = ed25519.LoadPublicKey("ed25519.pub")
+	if err != nil {
+		panic(err)
+	}
+}

_examples/ed25519_key_test.go

@@ -0,0 +1,24 @@
+// Copyright 2025 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	"testing"
+
+	"github.com/FishGoddess/cryptox/ed25519"
+)
+
+// go test -v -bench=^BenchmarkED25519_GenerateKeys$ -benchtime=1s ed25519_key_test.go
+func BenchmarkED25519_GenerateKeys(b *testing.B) {
+	b.ReportAllocs()
+	b.ResetTimer()
+
+	for i := 0; i < b.N; i++ {
+		_, _, err := ed25519.GenerateKeys()
+		if err != nil {
+			b.Fatal(err)
+		}
+	}
+}

_examples/ed25519_test.go

@@ -0,0 +1,55 @@
+// Copyright 2025 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	"testing"
+
+	"github.com/FishGoddess/cryptox/ed25519"
+)
+
+var (
+	ed25519BenchData = []byte("你好，世界")
+)
+
+// go test -v -bench=^BenchmarkED25519_Sign$ -benchtime=1s ed25519_test.go
+func BenchmarkED25519_Sign(b *testing.B) {
+	privateKey, err := ed25519.LoadPrivateKey("ed25519.key")
+	if err != nil {
+		b.Fatal(err)
+	}
+
+	b.ReportAllocs()
+	b.ResetTimer()
+
+	for i := 0; i < b.N; i++ {
+		privateKey.Sign(ed25519BenchData)
+	}
+}
+
+// go test -v -bench=^BenchmarkED25519_Verify$ -benchtime=1s ed25519_test.go
+func BenchmarkED25519_Verify(b *testing.B) {
+	privateKey, err := ed25519.LoadPrivateKey("ed25519.key")
+	if err != nil {
+		b.Fatal(err)
+	}
+
+	publicKey, err := ed25519.LoadPublicKey("ed25519.pub")
+	if err != nil {
+		b.Fatal(err)
+	}
+
+	sign := privateKey.Sign(ed25519BenchData)
+
+	b.ReportAllocs()
+	b.ResetTimer()
+
+	for i := 0; i < b.N; i++ {
+		err = publicKey.Verify(ed25519BenchData, sign)
+		if err != nil {
+			b.Fatal(err)
+		}
+	}
+}