feat: add base64 support for cryptor package

2026-02-06 21:52:28 +08:00 · 2023-07-27 17:54:26 +08:00
parent 5c01b7e675
commit 8587abc977
4 changed files with 824 additions and 36 deletions
--- a/docs/cryptor.md
+++ b/docs/cryptor.md
@@ -46,14 +46,24 @@ import (
 -   [DesOfbEncrypt](#DesOfbEncrypt)
 -   [DesOfbDecrypt](#DesOfbDecrypt)
 -   [HmacMd5](#HmacMd5)
+-   [HmacMd5WithBase64](#HmacMd5WithBase64)
 -   [HmacSha1](#HmacSha1)
+-   [HmacSha1WithBase64](#HmacSha1WithBase64)
 -   [HmacSha256](#HmacSha256)
+-   [HmacSha256WithBase64](#HmacSha256WithBase64)
 -   [HmacSha512](#HmacSha512)
+-   [HmacSha512WithBase64](#HmacSha512WithBase64)
 -   [Md5String](#Md5String)
+-   [Md5StringWithBase64](#Md5StringWithBase64)
+-   [Md5Byte](#Md5Byte)
+-   [Md5ByteWithBase64](#Md5ByteWithBase64)
 -   [Md5File](#Md5File)
 -   [Sha1](#Sha1)
+-   [Sha1WithBase64](#Sha1WithBase64)
 -   [Sha256](#Sha256)
+-   [Sha256WithBase64](#Sha256WithBase64)
 -   [Sha512](#Sha512)
+-   [Sha512WithBase64](#Sha512WithBase64)
 -   [GenerateRsaKey](#GenerateRsaKey)
 -   [RsaEncrypt](#RsaEncrypt)
 -   [RsaDecrypt](#RsaDecrypt)
@@ -664,6 +674,32 @@ func main() {
 }
 ```

+### <span id="HmacMd5WithBase64">HmacMd5WithBase64</span>
+
+<p>Return the hmac hash of string use md5 with base64.</p>
+
+<b>Signature:</b>
+
+```go
+func HmacMd5WithBase64(data, key string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    s := cryptor.HmacMd5WithBase64("hello", "12345"))
+    fmt.Println(s) //6DQwbquJLYclJdSRinpjmg==
+}
+```
+
 ### <span id="HmacSha1">HmacSha1</span>

 <p>Get the sha1 hmac hash of string.</p>
@@ -689,6 +725,37 @@ func main() {
    fmt.Println(s) //3826f812255d8683f051ee97346d1359234d5dbd
 }
 ```
+### <span id="HmacSha1WithBase64">HmacSha1WithBase64</span>
+
+<p>Return the hmac hash of string use sha1 with base64.</p>
+
+<b>Signature:</b>
+
+```go
+func HmacSha1WithBase64(str, key string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    str := "hello"
+    key := "12345"
+
+    hms := cryptor.HmacSha1WithBase64(str, key)
+    fmt.Println(hms)
+
+    // Output:
+    // XGqdsMzLkuNu0DI/0Jt/k23prOA=
+}
+```

 ### <span id="HmacSha256">HmacSha256</span>

@@ -716,6 +783,38 @@ func main() {
 }
 ```

+### <span id="HmacSha256WithBase64">HmacSha256WithBase64</span>
+
+<p>Return the hmac hash of string use sha256 with base64.</p>
+
+<b>Signature:</b>
+
+```go
+func HmacSha256WithBase64(str, key string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    str := "hello"
+    key := "12345"
+
+    hms := cryptor.HmacSha256WithBase64(str, key)
+    fmt.Println(hms)
+
+    // Output:
+    // MVu5PE6YmGK6Ccti4F1zpfN2yzbw14btqwwyDQWf3nU=
+}
+```
+
 ### <span id="HmacSha512">HmacSha512</span>

 <p>Get the sha512 hmac hash of string.</p>
@@ -742,6 +841,38 @@ func main() {
 }
 ```

+### <span id="HmacSha512WithBase64">HmacSha512WithBase64</span>
+
+<p>Return the hmac hash of string use sha512 with base64.</p>
+
+<b>Signature:</b>
+
+```go
+func HmacSha512WithBase64(str, key string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    str := "hello"
+    key := "12345"
+
+    hms := cryptor.HmacSha512WithBase64(str, key)
+    fmt.Println(hms)
+
+    // Output:
+    // 3Y8SkKndI9NU4lJtmi6c6M///dN8syCADRxsE9Lvw2Mog3ahlsVFja9T+OGqa0Wm2FYwPVwKIGS/+XhYYdSM/A==
+}
+```
+
 ### <span id="Md5String">Md5String</span>

 <p>Get the md5 value of string.</p>
@@ -768,6 +899,93 @@ func main() {
 }
 ```

+### <span id="Md5StringWithBase64">Md5StringWithBase64</span>
+
+<p>Return the md5 value of string with base64.</p>
+
+<b>Signature:</b>
+
+```go
+func Md5StringWithBase64(s string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    md5Str := cryptor.Md5StringWithBase64("hello")
+    fmt.Println(md5Str)
+
+    // Output:
+    // XUFAKrxLKna5cZ2REBfFkg==
+}
+```
+
+### <span id="Md5Byte">Md5Byte</span>
+
+<p>Return the md5 string of byte slice.</p>
+
+<b>Signature:</b>
+
+```go
+func Md5Byte(data []byte) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    md5Str := cryptor.Md5Byte([]byte{'a'})
+    fmt.Println(md5Str)
+
+    // Output:
+    // 0cc175b9c0f1b6a831c399e269772661
+}
+```
+
+### <span id="Md5ByteWithBase64">Md5ByteWithBase64</span>
+
+<p>Return the md5 string of byte slice with base64.</p>
+
+<b>Signature:</b>
+
+```go
+func Md5ByteWithBase64(data []byte) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    md5Str := cryptor.Md5ByteWithBase64([]byte("hello"))
+    fmt.Println(md5Str)
+
+    // Output:
+    // XUFAKrxLKna5cZ2REBfFkg==
+}
+```
+
 ### <span id="Md5File">Md5File</span>

 <p>Get the md5 value of file.</p>
@@ -820,6 +1038,35 @@ func main() {
 }
 ```

+### <span id="Sha1WithBase64">Sha1WithBase64</span>
+
+<p>Return the sha1 value (SHA-1 hash algorithm) of base64 string.</p>
+
+<b>Signature:</b>
+
+```go
+func Sha1WithBase64(str string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    result := cryptor.Sha1WithBase64("hello")
+    fmt.Println(result)
+
+    // Output:
+    // qvTGHdzF6KLavt4PO0gs2a6pQ00=
+}
+```
+
 ### <span id="Sha256">Sha256</span>

 <p>Get the sha256 value of string.</p>
@@ -846,6 +1093,35 @@ func main() {
 }
 ```

+### <span id="Sha256WithBase64">Sha256WithBase64</span>
+
+<p>Return the sha256 value (SHA256 hash algorithm) of base64 string.</p>
+
+<b>Signature:</b>
+
+```go
+func Sha256WithBase64(str string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    result := cryptor.Sha256WithBase64("hello")
+    fmt.Println(result)
+
+    // Output:
+    // LPJNul+wow4m6DsqxbninhsWHlwfp0JecwQzYpOLmCQ=
+}
+```
+
 ### <span id="Sha512">Sha512</span>

 <p>Get the sha512 value of string.</p>
@@ -872,6 +1148,35 @@ func main() {
 }
 ```

+### <span id="Sha512WithBase64">Sha512WithBase64</span>
+
+<p>Get the sha512 value of string with base64.</p>
+
+<b>Signature:</b>
+
+```go
+func Sha512WithBase64(str string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    result := cryptor.Sha512WithBase64("hello")
+    fmt.Println(result)
+
+    // Output:
+    // m3HSJL1i83hdltRq0+o9czGb+8KJDKra4t/3JRlnPKcjI8PZm6XBHXx6zG4UuMXaDEZjR1wuXDre9G9zvN7AQw==
+}
+```
+
 ### <span id="GenerateRsaKey">GenerateRsaKey</span>

 <p>Create the rsa public and private key file in current directory.</p>
--- a/docs/cryptor_zh-CN.md
+++ b/docs/cryptor_zh-CN.md
@@ -47,13 +47,22 @@ import (
 -   [DesOfbDecrypt](#DesOfbDecrypt)
 -   [HmacMd5](#HmacMd5)
 -   [HmacSha1](#HmacSha1)
+-   [HmacSha1WithBase64](#HmacSha1WithBase64)
 -   [HmacSha256](#HmacSha256)
+-   [HmacSha256WithBase64](#HmacSha256WithBase64)
 -   [HmacSha512](#HmacSha512)
+-   [HmacSha512WithBase64](#HmacSha512WithBase64)
 -   [Md5String](#Md5String)
+-   [Md5StringWithBase64](#Md5StringWithBase64)
+-   [Md5Byte](#Md5Byte)
+-   [Md5ByteWithBase64](#Md5ByteWithBase64)
 -   [Md5File](#Md5File)
 -   [Sha1](#Sha1)
+-   [Sha1WithBase64](#Sha1WithBase64)
 -   [Sha256](#Sha256)
+-   [Sha256WithBase64](#Sha256WithBase64)
 -   [Sha512](#Sha512)
+-   [Sha512WithBase64](#Sha512WithBase64)
 -   [GenerateRsaKey](#GenerateRsaKey)
 -   [RsaEncrypt](#RsaEncrypt)
 -   [RsaDecrypt](#RsaDecrypt)
@@ -663,6 +672,32 @@ func main() {
 }
 ```

+### <span id="HmacMd5WithBase64">HmacMd5WithBase64</span>
+
+<p>获取字符串md5 hmac base64值.</p>
+
+<b>函数签名:</b>
+
+```go
+func HmacMd5WithBase64(data, key string) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    s := cryptor.HmacMd5WithBase64("hello", "12345"))
+    fmt.Println(s) //6DQwbquJLYclJdSRinpjmg==
+}
+```
+
 ### <span id="HmacSha1">HmacSha1</span>

 <p>获取字符串sha1 hmac值</p>
@@ -689,17 +724,17 @@ func main() {
 }
 ```

-### <span id="HmacSha256">HmacSha256</span>
+### <span id="HmacSha1WithBase64">HmacSha1WithBase64</span>

-<p>获取字符串sha256 hmac值</p>
+<p>获取字符串的sha1 base64值。</p>

 <b>函数签名:</b>

 ```go
-func HmacSha256(data, key string) string
+func HmacSha1WithBase64(str, key string) string
 ```

-<b>列子:</b>
+<b>实例:</b>

 ```go
 package main
@@ -710,22 +745,93 @@ import (
 )

 func main() {
-    s := cryptor.HmacSha256("hello world", "12345"))
-    fmt.Println(s) //9dce2609f2d67d41f74c7f9efc8ccd44370d41ad2de52982627588dfe7289ab8
+    str := "hello"
+    key := "12345"
+
+    hms := cryptor.HmacSha1WithBase64(str, key)
+    fmt.Println(hms)
+
+    // Output:
+    // XGqdsMzLkuNu0DI/0Jt/k23prOA=
+}
+```
+
+
+### <span id="HmacSha256">HmacSha256</span>
+
+<p>获取字符串sha256 hmac值。</p>
+
+<b>函数签名:</b>
+
+```go
+func HmacSha256(str, key string) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    str := "hello"
+    key := "12345"
+
+    hms := cryptor.HmacSha256(str, key)
+    fmt.Println(hms)
+
+    // Output:
+    // 315bb93c4e989862ba09cb62e05d73a5f376cb36f0d786edab0c320d059fde75
+}
+```
+
+### <span id="HmacSha256WithBase64">HmacSha256WithBase64</span>
+
+<p>获取字符串sha256 hmac base64值。</p>
+
+<b>函数签名:</b>
+
+```go
+func HmacSha256WithBase64(str, key string) string
+```
+
+<b>实例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    str := "hello"
+    key := "12345"
+
+    hms := cryptor.HmacSha256WithBase64(str, key)
+    fmt.Println(hms)
+
+    // Output:
+    // MVu5PE6YmGK6Ccti4F1zpfN2yzbw14btqwwyDQWf3nU=
 }
 ```

 ### <span id="HmacSha512">HmacSha512</span>

-<p>获取字符串sha512 hmac值</p>
+<p>获取字符串sha512 hmac值。</p>

 <b>函数签名:</b>

 ```go
-func HmacSha512(data, key string) string
+func HmacSha512(str, key string) string
 ```

-<b>列子:</b>
+<b>示例:</b>

 ```go
 package main
@@ -736,23 +842,28 @@ import (
 )

 func main() {
-    s := cryptor.HmacSha512("hello world", "12345"))
-    fmt.Println(s)
- //5b1563ac4e9b49c9ada8ccb232588fc4f0c30fd12f756b3a0b95af4985c236ca60925253bae10ce2c6bf9af1c1679b51e5395ff3d2826c0a2c7c0d72225d4175
+    str := "hello"
+    key := "12345"
+
+    hms := cryptor.HmacSha512(str, key)
+    fmt.Println(hms)
+
+    // Output:
+    // dd8f1290a9dd23d354e2526d9a2e9ce8cffffdd37cb320800d1c6c13d2efc363288376a196c5458daf53f8e1aa6b45a6d856303d5c0a2064bff9785861d48cfc
 }
 ```

-### <span id="Md5String">Md5String</span>
+### <span id="HmacSha512WithBase64">HmacSha512WithBase64</span>

-<p>获取字符串md5值</p>
+<p>获取字符串sha512 hmac base64值。</p>

 <b>函数签名:</b>

 ```go
-func Md5String(s string) string
+func HmacSha512WithBase64(str, key string) string
 ```

-<b>列子:</b>
+<b>实例:</b>

 ```go
 package main
@@ -763,14 +874,139 @@ import (
 )

 func main() {
-    s := cryptor.Md5String("hello"))
-    fmt.Println(s) //5d41402abc4b2a76b9719d911017c592
+    str := "hello"
+	key := "12345"
+
+	hms := cryptor.HmacSha512WithBase64(str, key)
+	fmt.Println(hms)
+
+	// Output:
+	// 3Y8SkKndI9NU4lJtmi6c6M///dN8syCADRxsE9Lvw2Mog3ahlsVFja9T+OGqa0Wm2FYwPVwKIGS/+XhYYdSM/A==
+}
+```
+
+
+### <span id="Md5String">Md5String</span>
+
+<p>获取字符串md5值。</p>
+
+<b>函数签名:</b>
+
+```go
+func Md5String(str string) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    str := "hello"
+
+    md5Str := cryptor.Md5String(str)
+    fmt.Println(md5Str)
+
+    // Output:
+    // 5d41402abc4b2a76b9719d911017c592
+}
+```
+
+### <span id="Md5StringWithBase64">Md5StringWithBase64</span>
+
+<p>获取字符串md5 base64值。</p>
+
+<b>函数签名:</b>
+
+```go
+func Md5StringWithBase64(s string) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    md5Str := cryptor.Md5StringWithBase64("hello")
+	fmt.Println(md5Str)
+
+	// Output:
+	// XUFAKrxLKna5cZ2REBfFkg==
+}
+```
+
+### <span id="Md5Byte">Md5Byte</span>
+
+<p>获取byte slice的md5值。</p>
+
+<b>函数签名:</b>
+
+```go
+func Md5Byte(data []byte) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    md5Str := cryptor.Md5Byte([]byte{'a'})
+	fmt.Println(md5Str)
+
+	// Output:
+	// 0cc175b9c0f1b6a831c399e269772661
+}
+```
+
+### <span id="Md5ByteWithBase64">Md5ByteWithBase64</span>
+
+<p>获取byte slice的md5 base64值。</p>
+
+<b>函数签名:</b>
+
+```go
+func Md5ByteWithBase64(data []byte) string
+```
+
+<b>实例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    md5Str := cryptor.Md5ByteWithBase64([]byte("hello"))
+	fmt.Println(md5Str)
+
+	// Output:
+	// XUFAKrxLKna5cZ2REBfFkg==
 }
 ```

 ### <span id="Md5File">Md5File</span>

-<p>获取文件md5值.</p>
+<p>获取文件md5值。</p>

 <b>函数签名:</b>

@@ -778,7 +1014,7 @@ func main() {
 func Md5File(filepath string) (string, error)
 ```

-<b>列子:</b>
+<b>示例:</b>

 ```go
 package main
@@ -796,15 +1032,15 @@ func main() {

 ### <span id="Sha1">Sha1</span>

-<p>获取字符串sha1值</p>
+<p>获取字符串sha1值。</p>

 <b>函数签名:</b>

 ```go
-func Sha1(data string) string
+func Sha1(str string) string
 ```

-<b>列子:</b>
+<b>示例:</b>

 ```go
 package main
@@ -815,22 +1051,56 @@ import (
 )

 func main() {
-    s := cryptor.Sha1("hello world"))
-    fmt.Println(s) //2aae6c35c94fcfb415dbe95f408b9ce91ee846ed
+    str := "hello"
+
+    result := cryptor.Sha1(str)
+    fmt.Println(result)
+
+    // Output:
+    // aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d
+}
+```
+
+### <span id="Sha1WithBase64">Sha1WithBase64</span>
+
+<p>获取字符串sha1 base64值。</p>
+
+<b>函数签名:</b>
+
+```go
+func Sha1WithBase64(str string) string
+```
+
+<b>实例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    result := cryptor.Sha1WithBase64("hello")
+	fmt.Println(result)
+
+	// Output:
+	// qvTGHdzF6KLavt4PO0gs2a6pQ00=
 }
 ```

 ### <span id="Sha256">Sha256</span>

-<p>获取字符串sha256值</p>
+<p>获取字符串sha256值。</p>

 <b>函数签名:</b>

 ```go
-func Sha256(data string) string
+func Sha256(str string) string
 ```

-<b>列子:</b>
+<b>示例:</b>

 ```go
 package main
@@ -841,22 +1111,56 @@ import (
 )

 func main() {
-    s := cryptor.Sha256("hello world"))
-    fmt.Println(s) //b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9
+    str := "hello"
+
+    result := cryptor.Sha256(str)
+    fmt.Println(result)
+
+    // Output:
+    // 2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824
+}
+```
+
+### <span id="Sha256WithBase64">Sha256WithBase64</span>
+
+<p>获取字符串sha256 base64值。</p>
+
+<b>函数签名:</b>
+
+```go
+func Sha256WithBase64(str string) string
+```
+
+<b>实例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    result := cryptor.Sha256WithBase64("hello")
+	fmt.Println(result)
+
+	// Output:
+	// LPJNul+wow4m6DsqxbninhsWHlwfp0JecwQzYpOLmCQ=
 }
 ```

 ### <span id="Sha512">Sha512</span>

-<p>获取字符串sha512值</p>
+<p>获取字符串sha512值。</p>

 <b>函数签名:</b>

 ```go
-func Sha512(data string) string
+func Sha512(str string) string
 ```

-<b>列子:</b>
+<b>示例:</b>

 ```go
 package main
@@ -867,8 +1171,42 @@ import (
 )

 func main() {
-    s := cryptor.Sha512("hello world"))
-    fmt.Println(s) //309ecc489c12d6eb4cc40f50c902f2b4d0ed77ee511a7c7a9bcd3ca86d4cd86f989dd35bc5ff499670da34255b45b0cfd830e81f605dcf7dc5542e93ae9cd76f
+    str := "hello"
+
+    result := cryptor.Sha512(str)
+    fmt.Println(result)
+
+    // Output:
+    // 9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043
+}
+```
+
+### <span id="Sha512WithBase64">Sha512WithBase64</span>
+
+<p>获取字符串sha512 base64值。</p>
+
+<b>函数签名:</b>
+
+```go
+func Sha512WithBase64(str string) string
+```
+
+<b>实例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/cryptor"
+)
+
+func main() {
+    result := cryptor.Sha512WithBase64("hello")
+	fmt.Println(result)
+
+	// Output:
+	// m3HSJL1i83hdltRq0+o9czGb+8KJDKra4t/3JRlnPKcjI8PZm6XBHXx6zG4UuMXaDEZjR1wuXDre9G9zvN7AQw==
 }
 ```

@@ -958,7 +1296,7 @@ func main() {
    if err != nil {
        fmt.Println(err)
    }
-    
+
    data := []byte("hello world")
    encrypted := cryptor.RsaEncrypt(data, "rsa_public.pem")
    decrypted := cryptor.RsaDecrypt(encrypted, "rsa_private.pem")