feat(crypto): add gsha256

crypto/gsha256/gsha256.go

@@ -0,0 +1,52 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+// Package gsha256 provides useful API for SHA256 encryption algorithms.
+package gsha256
+
+import (
+	"crypto/sha256"
+	"encoding/hex"
+	"io"
+	"os"
+
+	"github.com/gogf/gf/v2/errors/gerror"
+	"github.com/gogf/gf/v2/util/gconv"
+)
+
+// Encrypt encrypts any type of variable using SHA256 algorithms.
+// It uses package gconv to convert `v` to its bytes type.
+func Encrypt(v any) string {
+	bs := sha256.Sum256(gconv.Bytes(v))
+	return hex.EncodeToString(bs[:])
+}
+
+// EncryptFile encrypts file content of `path` using SHA256 algorithms.
+func EncryptFile(path string) (encrypt string, err error) {
+	f, err := os.Open(path)
+	if err != nil {
+		err = gerror.Wrapf(err, `os.Open failed for name "%s"`, path)
+		return "", err
+	}
+	defer f.Close()
+	h := sha256.New()
+	_, err = io.Copy(h, f)
+	if err != nil {
+		err = gerror.Wrap(err, `io.Copy failed`)
+		return "", err
+	}
+	return hex.EncodeToString(h.Sum(nil)), nil
+}
+
+// MustEncryptFile encrypts file content of `path` using the SHA256 algorithm.
+// It panics if any error occurs.
+func MustEncryptFile(path string) string {
+	result, err := EncryptFile(path)
+	if err != nil {
+		panic(err)
+	}
+	return result
+}

crypto/gsha256/gsha256_z_unit_test.go

@@ -0,0 +1,61 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+// go test *.go -bench=".*"
+
+package gsha256_test
+
+import (
+	"os"
+	"testing"
+
+	"github.com/gogf/gf/v2/crypto/gsha256"
+	"github.com/gogf/gf/v2/test/gtest"
+)
+
+type user struct {
+	name     string
+	password string
+	age      int
+}
+
+func TestEncrypt(t *testing.T) {
+	gtest.C(t, func(t *gtest.T) {
+		result := "b5568f1b35aeb9eb7528336dea6c211a2cdcec1f333d98141b8adf346717907e"
+		s := gsha256.Encrypt("pibigstar")
+		t.AssertEQ(s, result)
+	})
+	gtest.C(t, func(t *gtest.T) {
+		user := &user{
+			name:     "派大星",
+			password: "123456",
+			age:      23,
+		}
+		result := "8e0293ca8e1860ae258a88429d3c14755712059d9562c825557a927718f574f3"
+		encrypt := gsha256.Encrypt(user)
+		t.AssertEQ(encrypt, result)
+	})
+}
+
+func TestEncryptFile(t *testing.T) {
+	path := "test.text"
+	errPath := "err.text"
+	gtest.C(t, func(t *gtest.T) {
+		result := "8fd86e81f66886d4ef7007c2df565f7f61dce2000d8b67ac7163be547c3115ef"
+		file, err := os.Create(path)
+		defer os.Remove(path)
+		defer file.Close()
+		t.AssertNil(err)
+		_, _ = file.Write([]byte("Hello Go Frame"))
+		encryptFile, err := gsha256.EncryptFile(path)
+		t.AssertNil(err)
+		t.AssertEQ(encryptFile, result)
+		// when the file is not exist,encrypt will return empty string
+		errEncrypt, err := gsha256.EncryptFile(errPath)
+		t.AssertNE(err, nil)
+		t.AssertEQ(errEncrypt, "")
+	})
+}