doc: normalize documents

2026-02-07 14:12:28 +08:00 · 2023-01-12 15:44:34 +08:00
parent 9ffe96d3ef
commit c260ce493d
12 changed files with 1883 additions and 1453 deletions
--- a/docs/cryptor.md
+++ b/docs/cryptor.md
@@ -61,8 +61,6 @@ import (

 ## Documentation

-
-
 ### <span id="AesEcbEncrypt">AesEcbEncrypt</span>

 <p>Encrypt data with key use AES ECB algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -83,16 +81,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesEcbEncrypt([]byte(data), []byte(key))
+    data := "hello"
+	key := "abcdefghijklmnop"

-    fmt.Println(string(encrypted))
+	encrypted := cryptor.AesEcbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesEcbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="AesEcbDecrypt">AesEcbDecrypt</span>

 <p>Decrypt data with key use AES ECB algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -113,16 +114,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesEcbEncrypt([]byte(data), []byte(key))
-    decrypted := cryptor.AesEcbDecrypt(encrypted, []byte(key))
-    fmt.Println(string(decrypted)) //hello world
+    data := "hello"
+	key := "abcdefghijklmnop"
+
+	encrypted := cryptor.AesEcbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesEcbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="AesCbcEncrypt">AesCbcEncrypt</span>

 <p>Encrypt data with key use AES CBC algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -143,16 +147,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesCbcEncrypt([]byte(data), []byte(key))
+    data := "hello"
+	key := "abcdefghijklmnop"

-    fmt.Println(string(encrypted))
+	encrypted := cryptor.AesCbcEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesCbcDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="AesCbcDecrypt">AesCbcDecrypt</span>

 <p>Decrypt data with key use AES CBC algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -174,16 +181,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesCbcEncrypt([]byte(data), []byte(key))
-    decrypted := cryptor.AesCbcDecrypt(encrypted, []byte(key))
-    fmt.Println(string(decrypted)) //hello world
+    data := "hello"
+	key := "abcdefghijklmnop"
+
+	encrypted := cryptor.AesCbcEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesCbcDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="AesCtrCrypt">AesCtrCrypt</span>

 <p>Encrypt or decrypt data with key use AES CTR algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -205,17 +215,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesCtrCrypt([]byte(data), []byte(key))
-    decrypted := cryptor.AesCtrCrypt(encrypted, []byte(key))
+    data := "hello"
+	key := "abcdefghijklmnop"

-    fmt.Println(string(decrypted)) //hello world
+	encrypted := cryptor.AesCtrCrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesCtrCrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="AesCfbEncrypt">AesCfbEncrypt</span>

 <p>Encrypt data with key use AES CFB algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -237,15 +249,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesCfbEncrypt([]byte(data), []byte(key))
-    fmt.Println(string(encrypted))
+    data := "hello"
+	key := "abcdefghijklmnop"
+
+	encrypted := cryptor.AesCfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesCfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="AesCfbDecrypt">AesCfbDecrypt</span>

 <p>Decrypt data with key use AES CBC algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -267,16 +283,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesCfbEncrypt([]byte(data), []byte(key))
-    decrypted := cryptor.AesCfbDecrypt(encrypted, []byte(key))
-    fmt.Println(string(decrypted)) //hello world
+    data := "hello"
+	key := "abcdefghijklmnop"
+
+	encrypted := cryptor.AesCfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesCfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="AesOfbEncrypt">AesOfbEncrypt</span>

 <p>Enecrypt data with key use AES OFB algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -298,15 +317,18 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesOfbEncrypt([]byte(data), []byte(key))
-    fmt.Println(string(encrypted))
+    data := "hello"
+	key := "abcdefghijklmnop"
+
+	encrypted := cryptor.AesOfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesCfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```
-
-
-
 ### <span id="AesCfbDecrypt">AesOfbDecrypt</span>

 <p>Decrypt data with key use AES OFB algorithm. Length of `key` param should be 16, 24 or 32.</p>
@@ -328,17 +350,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefghijklmnop"
-    encrypted := cryptor.AesOfbEncrypt([]byte(data), []byte(key))
-    decrypted := cryptor.AesOfbDecrypt(encrypted, []byte(key))
-    
-    fmt.Println(string(decrypted)) //hello world
+    data := "hello"
+	key := "abcdefghijklmnop"
+
+	encrypted := cryptor.AesOfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.AesCfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="Base64StdEncode">Base64StdEncode</span>

 <p>Encode string with base64 encoding.</p>
@@ -359,13 +383,13 @@ import (
 )

 func main() {
-    base64Str := cryptor.Base64StdEncode("hello world")
-    fmt.Println(base64Str) //aGVsbG8gd29ybGQ=
+    base64Str := cryptor.Base64StdEncode("hello")
+	fmt.Println(base64Str)
+
+	// Output:
+	// aGVsbG8=
 }
 ```
-
-
-
 ### <span id="Base64StdDecode">Base64StdDecode</span>

 <p>Decode a base64 encoded string.</p>
@@ -387,13 +411,14 @@ import (
 )

 func main() {
-    str := cryptor.Base64StdDecode("aGVsbG8gd29ybGQ=")
-    fmt.Println(str) //hello world
+    str := cryptor.Base64StdDecode("aGVsbG8=")
+	fmt.Println(str)
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="DesEcbEncrypt">DesEcbEncrypt</span>

 <p>Encrypt data with key use DES ECB algorithm. Length of `key` param should be 8.</p>
@@ -415,16 +440,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesEcbEncrypt([]byte(data), []byte(key))
+    data := "hello"
+	key := "abcdefgh"

-    fmt.Println(string(encrypted))
+	encrypted := cryptor.DesEcbEncrypt([]byte(data), []byte(key))
+
+	decrypted := cryptor.DesEcbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```
-
-
-
 ### <span id="DesEcbDecrypt">DesEcbDecrypt</span>

 <p>Decrypt data with key use DES ECB algorithm. Length of `key` param should be 8.</p>
@@ -446,17 +474,20 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesEcbEncrypt([]byte(data), []byt(key)
-    decrypted := cryptor.DesEcbDecrypt(encrypted, []byte(key))
-  
-    fmt.Println(string(decrypted)) //hello world
+    data := "hello"
+	key := "abcdefgh"
+
+	encrypted := cryptor.DesEcbEncrypt([]byte(data), []byte(key))
+
+	decrypted := cryptor.DesEcbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="DesCbcEncrypt">DesCbcEncrypt</span>

 <p>Encrypt data with key use DES CBC algorithm. Length of `key` param should be 8.</p>
@@ -478,16 +509,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesCbcEncrypt([]byte(data), []byt(key)
+    data := "hello"
+	key := "abcdefgh"

-    fmt.Println(string(encrypted))
+	encrypted := cryptor.DesCbcEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.DesCbcDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="DesCbcDecrypt">DesCbcDecrypt</span>

 <p>Decrypt data with key use DES CBC algorithm. Length of `key` param should be 8.</p>
@@ -509,17 +543,18 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesCbcEncrypt([]byte(data), []byt(key)
+    data := "hello"
+	key := "abcdefgh"
+
+	encrypted := cryptor.DesCbcEncrypt([]byte(data), []byte(key))
 	decrypted := cryptor.DesCbcDecrypt(encrypted, []byte(key))
-    
-    fmt.Println(string(decrypted)) //hello world
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```
-
-
-
 ### <span id="DesCtrCrypt">DesCtrCrypt</span>

 <p>Encrypt or decrypt data with key use DES CTR algorithm. Length of `key` param should be 8.</p>
@@ -541,17 +576,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesCtrCrypt([]byte(data), []byte(key))
-    decrypted := cryptor.DesCtrCrypt(encrypted, []byte(key))
+    data := "hello"
+	key := "abcdefgh"

-    fmt.Println(string(decrypted)) //hello world
+	encrypted := cryptor.DesCtrCrypt([]byte(data), []byte(key))
+	decrypted := cryptor.DesCtrCrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="DesCfbEncrypt">DesCfbEncrypt</span>

 <p>Encrypt data with key use DES CFB algorithm. Length of `key` param should be 8.</p>
@@ -573,15 +610,18 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesCfbEncrypt([]byte(data), []byt(key)
-    fmt.Println(string(encrypted))
+    data := "hello"
+	key := "abcdefgh"
+
+	encrypted := cryptor.DesCfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.DesCfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```
-
-
-
 ### <span id="DesCfbDecrypt">DesCfbDecrypt</span>

 <p>Decrypt data with key use DES CBC algorithm. Length of `key` param should be 8.</p>
@@ -603,16 +643,18 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesCfbEncrypt([]byte(data), []byt(key)
-    decrypted := cryptor.DesCfbDecrypt(encrypted, []byte(key))
-    fmt.Println(string(decrypted)) //hello world
+    data := "hello"
+	key := "abcdefgh"
+
+	encrypted := cryptor.DesCfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.DesCfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```
-
-
-
 ### <span id="DesOfbEncrypt">DesOfbEncrypt</span>

 <p>Enecrypt data with key use DES OFB algorithm. Length of `key` param should be 8.</p>
@@ -634,15 +676,18 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesOfbEncrypt([]byte(data), []byte(key))
-    fmt.Println(string(encrypted))
+    data := "hello"
+	key := "abcdefgh"
+
+	encrypted := cryptor.DesOfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.DesOfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```
-
-
-
 ### <span id="DesOfbDecrypt">DesOfbDecrypt</span>

 <p>Decrypt data with key use DES OFB algorithm. Length of `key` param should be 8.</p>
@@ -664,17 +709,19 @@ import (
 )

 func main() {
-    data := "hello world"
-    key := "abcdefgh"
-    encrypted := cryptor.DesOfbEncrypt([]byte(data), []byte(key))
-    decrypted := cryptor.DesOfbDecrypt(encrypted, []byte(key))
-    
-    fmt.Println(string(decrypted)) //hello world
+    data := "hello"
+	key := "abcdefgh"
+
+	encrypted := cryptor.DesOfbEncrypt([]byte(data), []byte(key))
+	decrypted := cryptor.DesOfbDecrypt(encrypted, []byte(key))
+
+	fmt.Println(string(decrypted))
+
+	// Output:
+	// hello
 }
 ```

-
-
 ### <span id="HmacMd5">HmacMd5</span>

 <p>Get the md5 hmac hash of string.</p>
@@ -696,13 +743,16 @@ import (
 )

 func main() {
-  	s := cryptor.HmacMd5("hello world", "12345"))
-  	fmt.Println(s) //5f4c9faaff0a1ad3007d9ddc06abe36d
+  	str := "hello"
+	key := "12345"
+
+	hms := cryptor.HmacMd5(str, key)
+	fmt.Println(hms)
+
+	// Output:
+	// e834306eab892d872525d4918a7a639a
 }
 ```
-
-
-
 ### <span id="HmacSha1">HmacSha1</span>

 <p>Get the sha1 hmac hash of string.</p>
@@ -724,13 +774,16 @@ import (
 )

 func main() {
-    s := cryptor.HmacSha1("hello world", "12345"))
-    fmt.Println(s) //3826f812255d8683f051ee97346d1359234d5dbd
+    str := "hello"
+	key := "12345"
+
+	hms := cryptor.HmacSha1(str, key)
+	fmt.Println(hms)
+
+	// Output:
+	// 5c6a9db0cccb92e36ed0323fd09b7f936de9ace0
 }
 ```
-
-
-
 ### <span id="HmacSha256">HmacSha256</span>

 <p>Get the sha256 hmac hash of string</p>
@@ -752,13 +805,17 @@ import (
 )

 func main() {
-    s := cryptor.HmacSha256("hello world", "12345"))
-    fmt.Println(s) //9dce2609f2d67d41f74c7f9efc8ccd44370d41ad2de52982627588dfe7289ab8
+    str := "hello"
+	key := "12345"
+
+	hms := cryptor.HmacSha256(str, key)
+	fmt.Println(hms)
+
+	// Output:
+	// 315bb93c4e989862ba09cb62e05d73a5f376cb36f0d786edab0c320d059fde75
 }
 ```

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

 <p>Get the sha512 hmac hash of string.</p>
@@ -780,14 +837,18 @@ 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>

 <p>Get the md5 value of string.</p>
@@ -809,13 +870,16 @@ import (
 )

 func main() {
-    s := cryptor.Md5String("hello"))
-    fmt.Println(s) //5d41402abc4b2a76b9719d911017c592
+    str := "hello"
+
+	md5Str := cryptor.Md5String(str)
+	fmt.Println(md5Str)
+
+	// Output:
+	// 5d41402abc4b2a76b9719d911017c592
 }
 ```

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

 <p>Get the md5 value of file.</p>
@@ -842,8 +906,6 @@ func main() {
 }
 ```

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

 <p>Get the sha1 value of string.</p>
@@ -865,13 +927,16 @@ 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="Sha256">Sha256</span>

 <p>Get the sha256 value of string.</p>
@@ -893,13 +958,16 @@ 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="Sha512">Sha512</span>

 <p>Get the sha512 value of string.</p>
@@ -921,13 +989,16 @@ 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="GenerateRsaKey">GenerateRsaKey</span>

 <p>Create the rsa public and private key file in current directory.</p>
@@ -956,8 +1027,6 @@ func main() {
 }
 ```

-
-
 ### <span id="RsaEncrypt">RsaEncrypt</span>

 <p>Encrypt data with public key file useing ras algorithm.</p>
@@ -981,19 +1050,21 @@ import (
 func main() {
    err := cryptor.GenerateRsaKey(4096, "rsa_private.pem", "rsa_public.pem")
    if err != nil {
-        fmt.Println(err)
+        return
    }
  	
-    data := []byte("hello world")
+    data := []byte("hello")
    encrypted := cryptor.RsaEncrypt(data, "rsa_public.pem")
    decrypted := cryptor.RsaDecrypt(encrypted, "rsa_private.pem")
  	
-    fmt.Println(string(decrypted)) //hello world
+    fmt.Println(string(decrypted))
+
+    // Output:
+	// hello
 }
 ```


-
 ### <span id="RsaDecrypt">RsaDecrypt</span>

 <p>Decrypt data with private key file useing ras algorithm.</p>
@@ -1017,14 +1088,17 @@ import (
 func main() {
    err := cryptor.GenerateRsaKey(4096, "rsa_private.pem", "rsa_public.pem")
    if err != nil {
-        fmt.Println(err)
+        return
    }
  	
-    data := []byte("hello world")
+    data := []byte("hello")
    encrypted := cryptor.RsaEncrypt(data, "rsa_public.pem")
    decrypted := cryptor.RsaDecrypt(encrypted, "rsa_private.pem")
  	
-    fmt.Println(string(decrypted)) //hello world
+    fmt.Println(string(decrypted))
+
+    // Output:
+	// hello
 }
 ```