doc: add doc for GenerateRsaKeyPair, RsaEncryptOAEP, RsaDecryptOAEP

2026-03-01 00:35:28 +08:00 · 2023-09-14 14:15:10 +08:00
parent 8ff37f0eff
commit 17b34f8f19
2 changed files with 307 additions and 77 deletions
@@ -1,6 +1,6 @@
 # Cryptor

-cryptor包包含数据加密和解密功能。支持 base64, md5, hmac, hash, aes, des, rsa。
+cryptor 包包含数据加密和解密功能。支持 base64, md5, hmac, hash, aes, des, rsa。

 <div STYLE="page-break-after: always;"></div>

@@ -65,6 +65,9 @@ import (
 -   [GenerateRsaKey](#GenerateRsaKey)
 -   [RsaEncrypt](#RsaEncrypt)
 -   [RsaDecrypt](#RsaDecrypt)
+-   [GenerateRsaKeyPair](#GenerateRsaKeyPair)
+-   [RsaEncryptOAEP](#RsaEncryptOAEP)
+-   [RsaDecryptOAEP](#RsaDecryptOAEP)

 <div STYLE="page-break-after: always;"></div>

@@ -1423,3 +1426,114 @@ func main() {
    // hello
 }
 ```
+
+### <span id="GenerateRsaKeyPair">GenerateRsaKeyPair</span>
+
+<p>创建rsa公钥私钥和key。</p>
+
+<b>函数签名:</b>
+
+```go
+func GenerateRsaKeyPair(keySize int) (*rsa.PrivateKey, *rsa.PublicKey)
+```
+
+<b>示例:></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/cryptor"
+)
+
+func main() {
+    pri, pub := cryptor.GenerateRsaKeyPair(1024)
+}
+```
+
+### <span id="RsaEncryptOAEP">RsaEncryptOAEP</span>
+
+<p>rsa OAEP加密。</p>
+
+<b>函数签名:</b>
+
+```go
+func RsaEncryptOAEP(data []byte, label []byte, key rsa.PublicKey) ([]byte, error)
+```
+
+<b>示例:></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/cryptor"
+)
+
+func main() {
+    pri, pub := cryptor.GenerateRsaKeyPair(1024)
+
+    data := []byte("hello world")
+    label := []byte("123456")
+
+    encrypted, err := cryptor.RsaEncryptOAEP(data, label, *pub)
+    if err != nil {
+        return
+    }
+
+    decrypted, err := cryptor.RsaDecryptOAEP([]byte(encrypted), label, *pri)
+    if err != nil {
+        return
+    }
+
+    fmt.Println(string(decrypted))
+
+    // Output:
+    // hello world
+}
+```
+
+### <span id="RsaDecryptOAEP">RsaDecryptOAEP</span>
+
+<p>rsa OAEP解密。</p>
+
+<b>函数签名:</b>
+
+```go
+func RsaDecryptOAEP(ciphertext []byte, label []byte, key rsa.PrivateKey) ([]byte, error)
+```
+
+<b>示例:></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/cryptor"
+)
+
+func main() {
+    pri, pub := cryptor.GenerateRsaKeyPair(1024)
+
+    data := []byte("hello world")
+    label := []byte("123456")
+
+    encrypted, err := cryptor.RsaEncryptOAEP(data, label, *pub)
+    if err != nil {
+        return
+    }
+
+    decrypted, err := cryptor.RsaDecryptOAEP([]byte(encrypted), label, *pri)
+    if err != nil {
+        return
+    }
+
+    fmt.Println(string(decrypted))
+
+    // Output:
+    // hello world
+}
+```
@@ -1,4 +1,5 @@
 # Cryptor
+
 Package cryptor contains some functions for data encryption and decryption. Support base64, md5, hmac, aes, des, rsa.

 <div STYLE="page-break-after: always;"></div>
@@ -8,11 +9,10 @@ Package cryptor contains some functions for data encryption and decryption. Supp
 -   [https://github.com/duke-git/lancet/blob/main/cryptor/basic.go](https://github.com/duke-git/lancet/blob/main/cryptor/basic.go)
 -   [https://github.com/duke-git/lancet/blob/main/cryptor/crypto.go](https://github.com/duke-git/lancet/blob/main/cryptor/crypto.go)

-
-
 <div STYLE="page-break-after: always;"></div>

 ## Usage:
+
 ```go
 import (
    "github.com/duke-git/lancet/v2/cryptor"
@@ -66,7 +66,6 @@ import (
 -   [RsaEncrypt](#RsaEncrypt)
 -   [RsaDecrypt](#RsaDecrypt)

-
 <div STYLE="page-break-after: always;"></div>

 ## Documentation
@@ -80,6 +79,7 @@ import (
 ```go
 func AesEcbEncrypt(data, key []byte) []byte
 ```
+
 <b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/zI6xsmuQRbn)</span></b>

 ```go
@@ -113,6 +113,7 @@ func main() {
 ```go
 func AesEcbDecrypt(encrypted, key []byte) []byte
 ```
+
 <b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/zI6xsmuQRbn)</span></b>

 ```go
@@ -146,6 +147,7 @@ func main() {
 ```go
 func AesCbcEncrypt(data, key []byte) []byte
 ```
+
 <b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/IOq_g8_lKZD)</span></b>

 ```go
@@ -339,6 +341,7 @@ func main() {
    // 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>
@@ -382,6 +385,7 @@ func main() {
 ```go
 func Base64StdEncode(s string) string
 ```
+
 <b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/VOaUyQUreoK)</span></b>

 ```go
@@ -400,6 +404,7 @@ func main() {
    // aGVsbG8=
 }
 ```
+
 ### <span id="Base64StdDecode">Base64StdDecode</span>

 <p>Decode a base64 encoded string.</p>
@@ -463,6 +468,7 @@ func main() {
    // hello
 }
 ```
+
 ### <span id="DesEcbDecrypt">DesEcbDecrypt</span>

 <p>Decrypt data with key use DES ECB algorithm. Length of `key` param should be 8.</p>
@@ -565,6 +571,7 @@ func main() {
    // 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>
@@ -632,6 +639,7 @@ func main() {
    // hello
 }
 ```
+
 ### <span id="DesCfbDecrypt">DesCfbDecrypt</span>

 <p>Decrypt data with key use DES CBC algorithm. Length of `key` param should be 8.</p>
@@ -665,6 +673,7 @@ func main() {
    // hello
 }
 ```
+
 ### <span id="DesOfbEncrypt">DesOfbEncrypt</span>

 <p>Enecrypt data with key use DES OFB algorithm. Length of `key` param should be 8.</p>
@@ -698,6 +707,7 @@ func main() {
    // hello
 }
 ```
+
 ### <span id="DesOfbDecrypt">DesOfbDecrypt</span>

 <p>Decrypt data with key use DES OFB algorithm. Length of `key` param should be 8.</p>
@@ -988,7 +998,6 @@ func main() {
 }
 ```

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

 <p>Get the md5 value of string.</p>
@@ -1378,7 +1387,6 @@ func main() {
 }
 ```

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

 <p>Decrypt data with private key file useing ras algorithm.</p>
@@ -1416,5 +1424,113 @@ func main() {
 }
 ```

+### <span id="GenerateRsaKeyPair">GenerateRsaKeyPair</span>

+<p>Creates rsa private and public key.</p>

+<b>Signature:</b>
+
+```go
+func GenerateRsaKeyPair(keySize int) (*rsa.PrivateKey, *rsa.PublicKey)
+```
+
+<b>Example:></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/cryptor"
+)
+
+func main() {
+    pri, pub := cryptor.GenerateRsaKeyPair(1024)
+}
+```
+
+### <span id="RsaEncryptOAEP">RsaEncryptOAEP</span>
+
+<p>Encrypts the given data with RSA-OAEP.</p>
+
+<b>Signature:</b>
+
+```go
+func RsaEncryptOAEP(data []byte, label []byte, key rsa.PublicKey) ([]byte, error)
+```
+
+<b>Example:></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/cryptor"
+)
+
+func main() {
+    pri, pub := cryptor.GenerateRsaKeyPair(1024)
+
+    data := []byte("hello world")
+    label := []byte("123456")
+
+    encrypted, err := cryptor.RsaEncryptOAEP(data, label, *pub)
+    if err != nil {
+        return
+    }
+
+    decrypted, err := cryptor.RsaDecryptOAEP([]byte(encrypted), label, *pri)
+    if err != nil {
+        return
+    }
+
+    fmt.Println(string(decrypted))
+
+    // Output:
+    // hello world
+}
+```
+
+### <span id="RsaDecryptOAEP">RsaDecryptOAEP</span>
+
+<p>Decrypts the data with RSA-OAEP.</p>
+
+<b>Signature:</b>
+
+```go
+func RsaDecryptOAEP(ciphertext []byte, label []byte, key rsa.PrivateKey) ([]byte, error)
+```
+
+<b>Example:></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/cryptor"
+)
+
+func main() {
+    pri, pub := cryptor.GenerateRsaKeyPair(1024)
+
+    data := []byte("hello world")
+    label := []byte("123456")
+
+    encrypted, err := cryptor.RsaEncryptOAEP(data, label, *pub)
+    if err != nil {
+        return
+    }
+
+    decrypted, err := cryptor.RsaDecryptOAEP([]byte(encrypted), label, *pri)
+    if err != nil {
+        return
+    }
+
+    fmt.Println(string(decrypted))
+
+    // Output:
+    // hello world
+}
+```