Skip to content

Commit b06f90c

Browse files
actions-useractions-user
committed
Update api docs
1 parent a4f23b6 commit b06f90c

File tree

3 files changed

+176
-17
lines changed

3 files changed

+176
-17
lines changed

‎api-manual/api/codec.md

Lines changed: 115 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@
7777
| [codec.PKCS7UnPaddingForDES](#pkcs7unpaddingfordes) ||
7878
| [codec.RC4Decrypt](#rc4decrypt) ||
7979
| [codec.RC4Encrypt](#rc4encrypt) ||
80-
| [codec.RSADecryptWithOAEP](#rsadecryptwithoaep) ||
81-
| [codec.RSADecryptWithPKCS1v15](#rsadecryptwithpkcs1v15) |DecryptWithPkcs1v15 将私钥与密文进行PKCS1v15解密，返回明文与错误 |
82-
| [codec.RSAEncryptWithOAEP](#rsaencryptwithoaep) ||
83-
| [codec.RSAEncryptWithPKCS1v15](#rsaencryptwithpkcs1v15) |EncryptWithPkcs1v15 将公钥与数据进行PKCS1v15加密，返回密文与错误 |
80+
| [codec.RSADecryptWithOAEP](#rsadecryptwithoaep) |RSADecryptWithOAEP 使用 RSA私钥 和 RSA-OAEP 填充方式解密给定的密文。 参数 raw 表示 RSA 私钥，支持以下格式： - DER 编码的私钥（raw ASN.1 DER 字节流） - Base64 编码的 DER 格式（自动解码） - PEM 编码（包...|
81+
| [codec.RSADecryptWithPKCS1v15](#rsadecryptwithpkcs1v15) |DecryptWithPkcs1v15/RSADecryptWithPKCS1v15 使用 RSA私钥 和 PKCS#1 v1.5填充方式 解密给定的密文。 参数 raw 表示 RSA 私钥，支持以下格式： - DER 编码的私钥（raw ASN.1 DER 字节流） - Base64...|
82+
| [codec.RSAEncryptWithOAEP](#rsaencryptwithoaep) |RSAEncryptWithOAEP 使用 RSA 公钥和 OAEP 填充方式对给定数据进行加密。 参数 raw 表示 RSA 公钥，支持以下格式： - DER 编码的公钥（raw ASN.1 DER 字节流） - Base64 编码的 DER 格式（自动解码） - PEM ...|
83+
| [codec.RSAEncryptWithPKCS1v15](#rsaencryptwithpkcs1v15) |EncryptWithPkcs1v15/RSAEncryptWithPKCS1v15 使用 RSA 公钥和 PKCS#1 v1.5 填充方式对给定数据进行加密。 参数 raw 表示 RSA 公钥，支持以下格式： - DER 编码的公钥（raw ASN.1 DER 字节流） - Ba...|
8484
| [codec.Sha1](#sha1) ||
8585
| [codec.Sha224](#sha224) ||
8686
| [codec.Sha256](#sha256) ||
@@ -1771,16 +1771,34 @@ replacing special characters (including /) with %XX sequences as needed.
17711771
### RSADecryptWithOAEP
17721772

17731773
#### 详细描述
1774+
RSADecryptWithOAEP 使用 RSA私钥 和 RSA-OAEP 填充方式解密给定的密文。
1775+
参数 raw 表示 RSA 私钥，支持以下格式：
1776+
- DER 编码的私钥（raw ASN.1 DER 字节流）
1777+
- Base64 编码的 DER 格式（自动解码）
1778+
- PEM 编码（包括带有 "-----BEGIN PRIVATE KEY-----" 或 "-----BEGIN RSA PRIVATE KEY-----" 的块）
1779+
- Base64 编码的 PEM 格式（自动解码）
1780+
1781+
参数 data 是加密后的数据（密文），可以是 []byte 或 base64 字符串等支持类型。
1782+
返回值是解密得到的原始明文，如果失败则返回错误。
1783+
1784+
示例：
1785+
1786+
raw := `
1787+
-----BEGIN PRIVATE KEY-----
1788+
MIIEvQIBADANBgkqhkiG9w0BAQEFAASC...（略）
1789+
-----END PRIVATE KEY-----
1790+
`
1791+
plaintext, err := Pkcs1v15Decrypt([]byte(raw), encryptedData)
17741792

17751793

17761794
#### 定义
17771795

1778-
`RSADecryptWithOAEP(pemPriBytes []byte, data any) ([]byte, error)`
1796+
`RSADecryptWithOAEP(raw []byte, data any) ([]byte, error)`
17791797

17801798
#### 参数
17811799
|参数名|参数类型|参数解释|
17821800
|:-----------|:---------- |:-----------|
1783-
| pemPriBytes | `[]byte` | |
1801+
| raw | `[]byte` | |
17841802
| data | `any` | |
17851803

17861804
#### 返回值
@@ -1793,11 +1811,37 @@ replacing special characters (including /) with %XX sequences as needed.
17931811
### RSADecryptWithPKCS1v15
17941812

17951813
#### 详细描述
1796-
DecryptWithPkcs1v15 将私钥与密文进行PKCS1v15解密，返回明文与错误
1814+
DecryptWithPkcs1v15/RSADecryptWithPKCS1v15 使用 RSA私钥 和 PKCS#1 v1.5填充方式 解密给定的密文。
1815+
1816+
参数 raw 表示 RSA 私钥，支持以下格式：
1817+
1818+
- DER 编码的私钥（raw ASN.1 DER 字节流）
1819+
1820+
- Base64 编码的 DER 格式（自动解码）
1821+
1822+
- PEM 编码（包括带有 "-----BEGIN PRIVATE KEY-----" 或 "-----BEGIN RSA PRIVATE KEY-----" 的块）
1823+
1824+
- Base64 编码的 PEM 格式（自动解码）
1825+
1826+
1827+
1828+
参数 data 是被加密后的数据（密文）
1829+
1830+
返回值是解密得到的原始明文，如果失败则返回错误。
1831+
1832+
17971833

17981834
Example:
17991835
```
1800-
dec, err := tls.DecryptWithPkcs1v15(raw, enc)
1836+
1837+
raw := `
1838+
-----BEGIN PRIVATE KEY-----
1839+
MIIEvQIBADANBgkqhkiG9w0BAQEFAASC...（略）
1840+
-----END PRIVATE KEY-----
1841+
`
1842+
plaintext, err := DecryptWithPkcs1v15(raw, encryptedData)
1843+
plaintext, err := RSADecryptWithPKCS1v15(raw, encryptedData)
1844+
18011845
```
18021846

18031847

@@ -1821,6 +1865,39 @@ dec, err := tls.DecryptWithPkcs1v15(raw, enc)
18211865
### RSAEncryptWithOAEP
18221866

18231867
#### 详细描述
1868+
RSAEncryptWithOAEP 使用 RSA 公钥和 OAEP 填充方式对给定数据进行加密。
1869+
1870+
1871+
1872+
参数 raw 表示 RSA 公钥，支持以下格式：
1873+
1874+
- DER 编码的公钥（raw ASN.1 DER 字节流）
1875+
1876+
- Base64 编码的 DER 格式（自动解码）
1877+
1878+
- PEM 编码（例如 "-----BEGIN PUBLIC KEY-----" 或 "-----BEGIN RSA PUBLIC KEY-----" 块）
1879+
1880+
- Base64 编码的 PEM 格式（自动解码）
1881+
1882+
1883+
1884+
参数 data 是要加密的明文数据，可以是 []byte、string 或其他可转换为字节数组的类型。
1885+
1886+
返回值是加密后的密文（字节切片），如果加密失败则返回错误。
1887+
1888+
1889+
1890+
Example:
1891+
```
1892+
1893+
raw := `
1894+
-----BEGIN PUBLIC KEY-----
1895+
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn...（略）
1896+
-----END PUBLIC KEY-----
1897+
`
1898+
ciphertext, err := RSAEncryptWithOAEP(raw, "hello world")
1899+
1900+
```
18241901

18251902

18261903
#### 定义
@@ -1843,11 +1920,39 @@ dec, err := tls.DecryptWithPkcs1v15(raw, enc)
18431920
### RSAEncryptWithPKCS1v15
18441921

18451922
#### 详细描述
1846-
EncryptWithPkcs1v15 将公钥与数据进行PKCS1v15加密，返回密文与错误
1923+
EncryptWithPkcs1v15/RSAEncryptWithPKCS1v15 使用 RSA 公钥和 PKCS#1 v1.5 填充方式对给定数据进行加密。
1924+
1925+
1926+
1927+
参数 raw 表示 RSA 公钥，支持以下格式：
1928+
1929+
- DER 编码的公钥（raw ASN.1 DER 字节流）
1930+
1931+
- Base64 编码的 DER 格式（自动解码）
1932+
1933+
- PEM 编码（例如 "-----BEGIN PUBLIC KEY-----" 或 "-----BEGIN RSA PUBLIC KEY-----" 块）
1934+
1935+
- Base64 编码的 PEM 格式（自动解码）
1936+
1937+
1938+
1939+
参数 data 是要加密的明文数据，可以是 []byte、string 或其他可转换为字节数组的类型。
1940+
1941+
返回值是加密后的密文（字节切片），如果加密失败则返回错误。
1942+
1943+
18471944

18481945
Example:
18491946
```
1850-
enc, err := tls.EncryptWithPkcs1v15(raw, "hello")
1947+
1948+
raw := `
1949+
-----BEGIN PUBLIC KEY-----
1950+
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn...（略）
1951+
-----END PUBLIC KEY-----
1952+
`
1953+
ciphertext, err := EncryptWithPkcs1v15(raw, "hello world")
1954+
ciphertext, err := RSAEncryptWithPKCS1v15(raw, "hello world")
1955+
18511956
```
18521957

18531958

‎api-manual/api/simulator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ htmlChangeMode|(simulator.loginDetectMode) 1|
77
leaklessDefault|(simulator.LeaklessMode) 0|
88
leaklessOff|(simulator.LeaklessMode) -1|
99
leaklessOn|(simulator.LeaklessMode) 1|
10-
simple|(map[string]interface {}) map[string]interface {}{"CreateBrowser": (func(...simple.BrowserConfigOpt) (*simple.VBrowser, error))(0x304b060), "bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) (*simple.VBrowser, error))(0x304b060), "exePath": (func(string) simple.BrowserConfigOpt)(0x304a660), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x304a960), "hijack": (func(bool) simple.BrowserConfigOpt)(0x304a9e0), "hostModifyTarget": "host", "leakless": (func(bool) simple.BrowserConfigOpt)(0x304afe0), "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x304a8e0), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x304a740), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x304ace0), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x304aa60), "timeout": (func(int) simple.BrowserConfigOpt)(0x304af60), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x304a580)}|
10+
simple|(map[string]interface {}) map[string]interface {}{"CreateBrowser": (func(...simple.BrowserConfigOpt) (*simple.VBrowser, error))(0x33a9ac0), "bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) (*simple.VBrowser, error))(0x33a9ac0), "exePath": (func(string) simple.BrowserConfigOpt)(0x33a90c0), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x33a93c0), "hijack": (func(bool) simple.BrowserConfigOpt)(0x33a9440), "hostModifyTarget": "host", "leakless": (func(bool) simple.BrowserConfigOpt)(0x33a9a40), "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x33a9340), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x33a91a0), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x33a9740), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x33a94c0), "timeout": (func(int) simple.BrowserConfigOpt)(0x33a99c0), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x33a8fe0)}|
1111
urlChangeMode|(simulator.loginDetectMode) 0|
1212

1313
|函数名|函数描述/介绍|

‎api-manual/api/tls.md

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
|函数名|函数描述/介绍|
44
|:------|:--------|
5-
| [tls.DecryptWithPkcs1v15](#decryptwithpkcs1v15) |DecryptWithPkcs1v15 将私钥与密文进行PKCS1v15解密，返回明文与错误 |
6-
| [tls.EncryptWithPkcs1v15](#encryptwithpkcs1v15) |EncryptWithPkcs1v15 将公钥与数据进行PKCS1v15加密，返回密文与错误 |
5+
| [tls.DecryptWithPkcs1v15](#decryptwithpkcs1v15) |DecryptWithPkcs1v15/RSADecryptWithPKCS1v15 使用 RSA私钥 和 PKCS#1 v1.5填充方式 解密给定的密文。 参数 raw 表示 RSA 私钥，支持以下格式： - DER 编码的私钥（raw ASN.1 DER 字节流） - Base64...|
6+
| [tls.EncryptWithPkcs1v15](#encryptwithpkcs1v15) |EncryptWithPkcs1v15/RSAEncryptWithPKCS1v15 使用 RSA 公钥和 PKCS#1 v1.5 填充方式对给定数据进行加密。 参数 raw 表示 RSA 公钥，支持以下格式： - DER 编码的公钥（raw ASN.1 DER 字节流） - Ba...|
77
| [tls.GenerateRSA1024KeyPair](#generatersa1024keypair) |GenerateRSA1024KeyPair 生成1024位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误 |
88
| [tls.GenerateRSA2048KeyPair](#generatersa2048keypair) |GenerateRSA2048KeyPair 生成2048位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误 |
99
| [tls.GenerateRSA4096KeyPair](#generatersa4096keypair) |GenerateRSA4096KeyPair 生成4096位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误 |
@@ -23,11 +23,37 @@
2323
### DecryptWithPkcs1v15
2424

2525
#### 详细描述
26-
DecryptWithPkcs1v15 将私钥与密文进行PKCS1v15解密，返回明文与错误
26+
DecryptWithPkcs1v15/RSADecryptWithPKCS1v15 使用 RSA私钥 和 PKCS#1 v1.5填充方式 解密给定的密文。
27+
28+
参数 raw 表示 RSA 私钥，支持以下格式：
29+
30+
- DER 编码的私钥（raw ASN.1 DER 字节流）
31+
32+
- Base64 编码的 DER 格式（自动解码）
33+
34+
- PEM 编码（包括带有 "-----BEGIN PRIVATE KEY-----" 或 "-----BEGIN RSA PRIVATE KEY-----" 的块）
35+
36+
- Base64 编码的 PEM 格式（自动解码）
37+
38+
39+
40+
参数 data 是被加密后的数据（密文）
41+
42+
返回值是解密得到的原始明文，如果失败则返回错误。
43+
44+
2745

2846
Example:
2947
```
30-
dec, err := tls.DecryptWithPkcs1v15(raw, enc)
48+
49+
raw := `
50+
-----BEGIN PRIVATE KEY-----
51+
MIIEvQIBADANBgkqhkiG9w0BAQEFAASC...（略）
52+
-----END PRIVATE KEY-----
53+
`
54+
plaintext, err := DecryptWithPkcs1v15(raw, encryptedData)
55+
plaintext, err := RSADecryptWithPKCS1v15(raw, encryptedData)
56+
3157
```
3258

3359

@@ -51,11 +77,39 @@ dec, err := tls.DecryptWithPkcs1v15(raw, enc)
5177
### EncryptWithPkcs1v15
5278

5379
#### 详细描述
54-
EncryptWithPkcs1v15 将公钥与数据进行PKCS1v15加密，返回密文与错误
80+
EncryptWithPkcs1v15/RSAEncryptWithPKCS1v15 使用 RSA 公钥和 PKCS#1 v1.5 填充方式对给定数据进行加密。
81+
82+
83+
84+
参数 raw 表示 RSA 公钥，支持以下格式：
85+
86+
- DER 编码的公钥（raw ASN.1 DER 字节流）
87+
88+
- Base64 编码的 DER 格式（自动解码）
89+
90+
- PEM 编码（例如 "-----BEGIN PUBLIC KEY-----" 或 "-----BEGIN RSA PUBLIC KEY-----" 块）
91+
92+
- Base64 编码的 PEM 格式（自动解码）
93+
94+
95+
96+
参数 data 是要加密的明文数据，可以是 []byte、string 或其他可转换为字节数组的类型。
97+
98+
返回值是加密后的密文（字节切片），如果加密失败则返回错误。
99+
100+
55101

56102
Example:
57103
```
58-
enc, err := tls.EncryptWithPkcs1v15(raw, "hello")
104+
105+
raw := `
106+
-----BEGIN PUBLIC KEY-----
107+
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn...（略）
108+
-----END PUBLIC KEY-----
109+
`
110+
ciphertext, err := EncryptWithPkcs1v15(raw, "hello world")
111+
ciphertext, err := RSAEncryptWithPKCS1v15(raw, "hello world")
112+
59113
```
60114

61115

0 commit comments

Comments
 (0)