重构 padding 和 encoding 和 rand 包

Author: FishGoddess

FUTURE.md

@@ -1,20 +1,24 @@
 ## ✈️ 未来版本的新特性 (Features in future versions)
 
-### v0.5.x
+### v0.6.x
 
 * [ ] 增加 cmd 包，提供二进制 cli 使用
 * [ ] 支持 SM3 国标算法
 * [ ] 支持 SM4 国标算法
+
+### v0.5.x
+
 * [ ] 支持 ECC key 生成
 * [ ] 支持 ECC 非对称加密算法
 * [ ] 支持更多的散列算法
+* [ ] 重构代码，优化使用方式
+* [ ] 继续完善单元测试，提升覆盖率到 90% 以上
 
 ### v0.4.x
 
 * [x] 调整 hash 包使用姿势
 * [x] 大规模重构，优化代码使用
 * [x] 性能优化，尝试减少内存分配
-* [ ] 继续完善单元测试，提升覆盖率到 90%
 
 ### v0.3.x
 

README.en.md

@@ -18,7 +18,7 @@
 * DES/3DES/AES encrypt and decrypt supports.
 * RSA/ECC encrypt and decrypt supports.
 * ECB/CBC/OFB/CFB/CTR/GCM mode supports.
-* NONE/ZERO/PKCS5/PKCS7 padding supports.
+* ZERO/PKCS5/PKCS7 padding supports.
 
 _Check [HISTORY.md](./HISTORY.md) and [FUTURE.md](./FUTURE.md) to know about more information._
 

README.md

@@ -18,7 +18,7 @@
 * 支持 DES/3DES/AES 等对称加密算法。
 * 支持 RSA/ECC 等非对称加密算法。
 * 支持 ECB/CBC/OFB/CFB/CTR/GCM 等分组模式。
-* 支持 NONE/ZERO/PKCS5/PKCS7 等填充方式。
+* 支持 ZERO/PKCS5/PKCS7 等字节填充方式。
 
 _历史版本的特性请查看 [HISTORY.md](./HISTORY.md)。未来版本的新特性和计划请查看 [FUTURE.md](./FUTURE.md)。_
 

_examples/hash.go

@@ -7,65 +7,72 @@ package main
 import (
 	"fmt"
 
+	"github.com/FishGoddess/cryptox/bytes/encoding"
 	"github.com/FishGoddess/cryptox/hash"
 )
 
 func main() {
 	data := []byte("你好，世界")
-	fmt.Println("data:", data)
-
-	// All hashing functions will return a cryptox.Bytes type which can be encoded to hex and base64.
-
-	md5 := hash.MD5(data)
-	fmt.Println("md5 hex:", md5.Hex())
-	fmt.Println("md5 base64:", md5.Base64())
-
-	sha1 := hash.SHA1(data)
-	fmt.Println("sha1 hex:", sha1.Hex())
-	fmt.Println("sha1 base64:", sha1.Base64())
-
-	sha224 := hash.SHA224(data)
-	fmt.Println("sha224 hex:", sha224.Hex())
-	fmt.Println("sha224 base64:", sha224.Base64())
-
-	sha256 := hash.SHA256(data)
-	fmt.Println("sha256 hex:", sha256.Hex())
-	fmt.Println("sha256 base64:", sha256.Base64())
-
-	sha384 := hash.SHA384(data)
-	fmt.Println("sha384 hex:", sha384.Hex())
-	fmt.Println("sha384 base64:", sha384.Base64())
-
-	sha512 := hash.SHA512(data)
-	fmt.Println("sha512 hex:", sha512.Hex())
-	fmt.Println("sha512 base64:", sha512.Base64())
+	fmt.Printf("data: %s\n", data)
+
+	md5Hex := hash.MD5(data, encoding.Hex)
+	md5Base64 := hash.MD5(data, encoding.Base64)
+	fmt.Printf("md5 hex: %s\n", md5Hex)
+	fmt.Printf("md5 base64: %s\n", md5Base64)
+
+	sha1Hex := hash.SHA1(data, encoding.Hex)
+	sha1Base64 := hash.SHA1(data, encoding.Base64)
+	fmt.Printf("sha1 hex: %s\n", sha1Hex)
+	fmt.Printf("sha1 base64: %s\n", sha1Base64)
+
+	sha224Hex := hash.SHA224(data, encoding.Hex)
+	sha224Base64 := hash.SHA224(data, encoding.Base64)
+	fmt.Printf("sha224 hex: %s\n", sha224Hex)
+	fmt.Printf("sha224 base64: %s\n", sha224Base64)
+
+	sha256Hex := hash.SHA256(data, encoding.Hex)
+	sha256Base64 := hash.SHA256(data, encoding.Base64)
+	fmt.Printf("sha256 hex: %s\n", sha256Hex)
+	fmt.Printf("sha256 base64: %s\n", sha256Base64)
+
+	sha384Hex := hash.SHA384(data, encoding.Hex)
+	sha384Base64 := hash.SHA384(data, encoding.Base64)
+	fmt.Printf("sha384 hex: %s\n", sha384Hex)
+	fmt.Printf("sha384 base64: %s\n", sha384Base64)
+
+	sha512Hex := hash.SHA512(data, encoding.Hex)
+	sha512Base64 := hash.SHA512(data, encoding.Base64)
+	fmt.Printf("sha512 hex: %s\n", sha512Hex)
+	fmt.Printf("sha512 base64: %s\n", sha512Base64)
 
 	crc32 := hash.CRC32IEEE(data)
-	fmt.Printf("crc32 with ieee: %d\n", crc32)
+	fmt.Printf("crc32 ieee: %d\n", crc32)
 
 	crc64 := hash.CRC64ISO(data)
-	fmt.Printf("crc64 with iso: %d\n", crc64)
+	fmt.Printf("crc64 iso: %d\n", crc64)
 
 	crc64 = hash.CRC64ECMA(data)
-	fmt.Printf("crc64 with ecma: %d\n", crc64)
+	fmt.Printf("crc64 ecma: %d\n", crc64)
 
 	fnv32 := hash.Fnv32(data)
-	fmt.Printf("fnv-1/32: %d\n", fnv32)
+	fmt.Printf("fnv32: %d\n", fnv32)
 
 	fnv32a := hash.Fnv32a(data)
-	fmt.Printf("fnv-1/32a: %d\n", fnv32a)
+	fmt.Printf("fnv32a: %d\n", fnv32a)
 
 	fnv64 := hash.Fnv64(data)
-	fmt.Printf("fnv-1/64: %d\n", fnv64)
+	fmt.Printf("fnv64: %d\n", fnv64)
 
 	fnv64a := hash.Fnv64a(data)
-	fmt.Printf("fnv-1/64a: %d\n", fnv64a)
+	fmt.Printf("fnv64a: %d\n", fnv64a)
 
-	fnv128 := hash.Fnv128(data)
-	fmt.Printf("fnv-1/128 hex: %s\n", fnv128.Hex())
-	fmt.Printf("fnv-1/128 base64: %s\n", fnv128.Base64())
+	fnv128Hex := hash.Fnv128(data, encoding.Hex)
+	fnv128Base64 := hash.Fnv128(data, encoding.Base64)
+	fmt.Printf("fnv128 hex: %s\n", fnv128Hex)
+	fmt.Printf("fnv128 base64: %s\n", fnv128Base64)
 
-	fnv128a := hash.Fnv128a(data)
-	fmt.Printf("fnv-1/128a hex: %s\n", fnv128a.Hex())
-	fmt.Printf("fnv-1/128a base64: %s\n", fnv128a.Base64())
+	fnv128aHex := hash.Fnv128a(data, encoding.Hex)
+	fnv128aBase64 := hash.Fnv128a(data, encoding.Base64)
+	fmt.Printf("fnv128a hex: %s\n", fnv128aHex)
+	fmt.Printf("fnv128a base64: %s\n", fnv128aBase64)
 }

_examples/hash_test.go

@@ -7,6 +7,7 @@ package main
 import (
 	"testing"
 
+	"github.com/FishGoddess/cryptox/bytes/encoding"
 	"github.com/FishGoddess/cryptox/hash"
 )
 
@@ -20,7 +21,7 @@ func BenchmarkMD5(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.MD5(benchData)
+		hash.MD5(benchData, encoding.None)
 	}
 }
 
@@ -30,7 +31,7 @@ func BenchmarkSHA1(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.SHA1(benchData)
+		hash.SHA1(benchData, encoding.None)
 	}
 }
 
@@ -40,7 +41,7 @@ func BenchmarkSHA224(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.SHA224(benchData)
+		hash.SHA224(benchData, encoding.None)
 	}
 }
 
@@ -50,7 +51,7 @@ func BenchmarkSHA256(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.SHA256(benchData)
+		hash.SHA256(benchData, encoding.None)
 	}
 }
 
@@ -60,7 +61,7 @@ func BenchmarkSHA384(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.SHA384(benchData)
+		hash.SHA384(benchData, encoding.None)
 	}
 }
 
@@ -70,7 +71,7 @@ func BenchmarkSHA512(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.SHA512(benchData)
+		hash.SHA512(benchData, encoding.None)
 	}
 }
 
@@ -150,7 +151,7 @@ func BenchmarkFnv128(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.Fnv128(benchData)
+		hash.Fnv128(benchData, encoding.None)
 	}
 }
 
@@ -160,6 +161,6 @@ func BenchmarkFnv128a(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		hash.Fnv128a(benchData)
+		hash.Fnv128a(benchData, encoding.None)
 	}
 }

_examples/rand.go

@@ -7,20 +7,20 @@ package main
 import (
 	"fmt"
 
-	"github.com/FishGoddess/cryptox"
+	"github.com/FishGoddess/cryptox/bytes/rand"
 )
 
 func main() {
 	// We provide some rand functions for you.
 	// If you want to generate some keys or ivs, just feel free to use them.
-	bs := cryptox.GenerateBytes(32)
-	fmt.Println(bs)
+	bs := rand.Bytes(32)
+	fmt.Printf("%s\n", bs)
 
-	str := cryptox.GenerateString(64)
-	fmt.Println(str)
+	str := rand.String(64)
+	fmt.Printf("%s\n", str)
 
 	// Already have a byte slice? Try AppendBytes:
-	bs = make(cryptox.Bytes, 0, 16)
-	bs = cryptox.AppendBytes(bs, 16)
-	fmt.Println(bs)
+	bs = []byte{'a', 'b', 'c', '-'}
+	bs = rand.AppendBytes(bs, 16)
+	fmt.Printf("%s\n", bs)
 }

_examples/rand_test.go

@@ -7,25 +7,25 @@ package main
 import (
 	"testing"
 
-	"github.com/FishGoddess/cryptox"
+	"github.com/FishGoddess/cryptox/bytes/rand"
 )
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^$ -bench=^BenchmarkGenerateBytes$
-func BenchmarkGenerateBytes(b *testing.B) {
+// go test -v -cover -run=^$ -bench=^BenchmarkBytes$
+func BenchmarkBytes(b *testing.B) {
 	b.ReportAllocs()
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		cryptox.GenerateBytes(16)
+		rand.Bytes(16)
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^$ -bench=^BenchmarkGenerateString$
-func BenchmarkGenerateString(b *testing.B) {
+// go test -v -cover -run=^$ -bench=^BenchmarkString$
+func BenchmarkString(b *testing.B) {
 	b.ReportAllocs()
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		cryptox.GenerateString(16)
+		rand.String(16)
 	}
 }

aes/aes_test.go

@@ -39,7 +39,7 @@ func (tr *testResult) compareTo(bs cryptox.Bytes) error {
 	return nil
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestNewBlock$
+// go test -v -cover -run=^TestNewBlock$
 func TestNewBlock(t *testing.T) {
 	block, blockSize, err := newBlock(testKey)
 	if err != nil {
@@ -64,7 +64,7 @@ func TestNewBlock(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestECB$
+// go test -v -cover -run=^TestECB$
 func TestECB(t *testing.T) {
 	cases := map[string]*testResult{
 		"": {
@@ -105,7 +105,7 @@ func TestECB(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestCBC$
+// go test -v -cover -run=^TestCBC$
 func TestCBC(t *testing.T) {
 	cases := map[string]*testResult{
 		"": {
@@ -146,7 +146,7 @@ func TestCBC(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestCFB$
+// go test -v -cover -run=^TestCFB$
 func TestCFB(t *testing.T) {
 	cases := map[string]*testResult{
 		"": {
@@ -187,7 +187,7 @@ func TestCFB(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestOFB$
+// go test -v -cover -run=^TestOFB$
 func TestOFB(t *testing.T) {
 	cases := map[string]*testResult{
 		"": {
@@ -228,7 +228,7 @@ func TestOFB(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestCTR$
+// go test -v -cover -run=^TestCTR$
 func TestCTR(t *testing.T) {
 	cases := map[string]*testResult{
 		"": {
@@ -269,7 +269,7 @@ func TestCTR(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestGCM$
+// go test -v -cover -run=^TestGCM$
 func TestGCM(t *testing.T) {
 	cases := map[string]*testResult{
 		"123": {

aes/gcm.go

@@ -0,0 +1,13 @@
+// Copyright 2024 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 aes
+
+import "github.com/FishGoddess/cryptox/bytes/rand"
+
+// Nonce returns a standard nonce for gcm.
+func Nonce() []byte {
+	nonceSize := 12
+	return rand.Bytes(nonceSize)
+}